Klasa SecuritySsl

namespace Kei\Webas\Dedicated

Klasa oferująca obsługę instalacji certyfikatów SSL. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/SecuritySsl.


Charakterystyka

Metody obiektu - zapoznaj się z opisem pod tabelą.

Index Lista zasobów w postaci tabeli danych
Add Dodanie nowego certyfikatu SSL
Edit Edycja ustawień certyfikatu SSL
Generate Wygeneruj nowy CSR
Remove Usuń wybrany certyfikat SSL

Każda z powyższych metod zwraca odpowiadający jej obiekt klasy znajdujący się w tej samej przestrzeni nazw i nazywający się tak samo jak metoda do której się odnosi.

Np. metoda Edit klasy \Kei\Webas\Dedicated\SecuritySsl zwraca obiekt \Kei\Webas\Dedicated\SecuritySsl\Edit itd.

Po kliknięciu w jedną z powyższych metod przejdziesz do strony charakteryzującej odpowiadający jej obiekt.



Wyjątki

Wyjątki jakie zwraca ta klasa oraz pozostałe klasy powiązane są następujące:

  • \Kei\Webas\Dedicated\SecuritySsl\Exception\DevelopmentStageException
  • \Kei\Webas\Dedicated\SecuritySsl\Exception\FileOriginException
  • \Kei\Webas\Dedicated\SecuritySsl\Exception\ServiceFoundException
  • \Kei\Webas\Dedicated\SecuritySsl\Exception\ResultException
  • \Kei\Webas\Dedicated\SecuritySsl\Exception\ValidationException
  • \Kei\Webas\Dedicated\SecuritySsl\Exception\WrongTypeException

oraz wyjątki standardowe dla wszystkich obiektów położonych wyżej w hierarchii:

  • \Kei\Webas\Dedicated\Exception\DefaultPaginatorActionException
  • \Kei\Webas\Dedicated\Exception\InfoTableColumnCountException
  • \Kei\Webas\Dedicated\Exception\InitialCookieNotFoundException
  • \Kei\Webas\Dedicated\Exception\ServiceNumberFormatException
  • \Kei\Webas\Dedicated\Exception\UncountableResultsException
  • \Kei\Webas\Dedicated\Exception\WebasAuthenticationException
  • \Kei\Webas\Dedicated\Exception\WebasConnectionException

Pamiętaj o tym, aby zawsze być przygotowanym na zwrócenie wyjątku przez skrypt PHP niezależnie od tego jak bardzo małoprawdopodobnym uważasz jego wystąpienie.


Przykłady wykorzystania metod

W poniższym przykładzie pominięto autoryzację do serwera. Obiekt Client znajduje się w zmiennej $webas. Więcej o autoryzacji przeczytasz w dziale jak rozpocząć ?

Nie zawijaj wierszy<?php
// Autoryzacja...

// Lista wszystkich certyfikatów SSL
$table = $webas->SecuritySsl()->Index()->setSearch("")->setPaginator(1, 25)->paginate();
\Kei\Library\Out::pd($table);


// Dodanie nowego certyfikatu SSL...
// Plik z certyfikatem
$cert = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/6ec30ad735f01024d8498cbd4759992d.cer');

// Plik z kluczem
$key = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/private.key');

// Połączenie wszystkiego w całość i zapisanie certyfikatu na stałe na serwerze
$webas->SecuritySsl()->
    Add($cert, $key, 'g5dg0abi')->
    execute();

// xoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxo //

// Edycja certyfikatu o wybranym identyfikatorze
$cert = $webas->SecuritySsl()->Edit('af06d58cb8d0e1475b608b28f81440e6');

// Czy jest opcja zmiany pliku z certyfikatem ?
if($cert->hasCertificateFile())
{
    $cert_file = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
        setFilePath('moja/lokalizacja/6ec30ad735f01024d8498cbd4759992d.cer');

    $cert->setCertificateFile($cert_file);
}

// Czy jest opcja zmiany pliku z kluczem ?
if($cert->hasKeyFile())
{
    $key_file = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
        setFilePath('moja/lokalizacja/private.key');

    $cert->setKeyFile($key_file);
}

// Czy jest opcja zmiany konta FTP ?
if($cert->hasFtpAccount()) { $cert->setFtpAccount('admin'); }

// Wykonanie edycji i zastosowanie zmian w wybranym certyfikacie
$result = $cert->execute()->getActionResult();
\Kei\Library\Out::vd($result);

// xoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxo //

// Add CSR request
$webas->SecuritySsl()->
    Generate(\Kei\Webas\Dedicated\SecuritySsl\WildcardEnum::OneDomainWithSubdomains, ['qwerty.com', 'asdf.pl'], 'MojaFirmaNet', 'biuro@mojafirma.pl')->
    setFtpAccount('admin')->
    setActionMode(\Kei\Webas\Dedicated\SecuritySsl\ActionModeEnum::SelfSignedCertificate)->
    execute();

// xoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxoxo //

// Usunięcie wybranego certyfikatu
$webas->SecuritySsl()->Remove("d6e11e220c5d937c5d1fc7ab89f1e81b")->execute();

Klasa SecuritySsl · NiceAPI dla PHP 5.6