Alternc_Api_Object_Ssl Class Reference

SSL Api of AlternC, used by alternc-api package. More...

Inheritance diagram for Alternc_Api_Object_Ssl:

Public Member Functions
	__construct ($service)
	getList ($options)
	API Method from legacy class get_list() More...
	newCsr ($options)
	API Method from legacy class new_csr() More...
	getCertificate ($options)
	API Method from legacy class get_certificate() More...
	share ($options)
	API Method from legacy class share() More...
	importCert ($options)
	API Method from legacy class import_cert() More...
	finalize ($options)
	API Method from legacy class finalize() More...
	aliasAdd ($options)
	API Method from legacy class alias_add() More...
	aliasDel ($options)
	API Method from legacy class alias_del() More...

Public Attributes
const	ERR_INVALID_ARGUMENT = 111201
const	ERR_ALTERNC_FUNCTION = 111202
const	ERR_NOT_FOUND = 111203

Protected Member Functions
	alterncLegacyErrorManager ()
	return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class More...
	offsetAndCount ($options, $max)
	ensure that offset & count are set properly from $options. More...

Protected Attributes
	$ssl
	$admin
	$cuid
	$isAdmin
	$db

Detailed Description

SSL Api of AlternC, used by alternc-api package.

Definition at line 6 of file Ssl.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Object_Ssl::__construct

(

$service

)

Reimplemented from Alternc_Api_Legacyobject.

Definition at line 10 of file Ssl.php.

                                 {
    global $ssl;
    parent::__construct($service);
    // We use the global $ssl from AlternC legacy classes
    $this->ssl=$ssl;
  }

References $ssl.

Member Function Documentation

aliasAdd()

Alternc_Api_Object_Ssl::aliasAdd

(

$options

)

API Method from legacy class alias_add()

Parameters

$options

a hash with parameters transmitted to legacy call add the alias 'name' with the content value 'value' in the global apache configuration

Returns

Alternc_Api_Response true

Definition at line 152 of file Ssl.php.

                              {
    if (!isset($options["name"]) || !is_string($options["name"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: NAME") );
    }
    if (!isset($options["content"]) || !is_string($options["content"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: CONTENT") );
    }
 
    $isok=$this->ssl->alias_add($options["name"],$options["content"]);
    if ($isok===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $isok) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

aliasDel()

Alternc_Api_Object_Ssl::aliasDel

(

$options

)

API Method from legacy class alias_del()

Parameters

$options

a hash with parameters transmitted to legacy call del the alias 'name' in the global apache configuration

Returns

Alternc_Api_Response true

Definition at line 173 of file Ssl.php.

                              {
    if (!isset($options["name"]) || !is_string($options["name"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: NAME") );
    }
 
    $isok=$this->ssl->alias_del($options["name"]);
    if ($isok===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $isok) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

alterncLegacyErrorManager()

Alternc_Api_Legacyobject::alterncLegacyErrorManager ( )

protectedinherited

return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class

Definition at line 38 of file Legacyobject.php.

                                                   {
        global $err;
        return new Alternc_Api_Response(array("code" => self::ERR_ALTERNC_FUNCTION, "message" => "[" . $err->clsid . "] " . $err->error));
    }

References $err.

Referenced by Alternc_Api_Object_Mail\account(), Alternc_Api_Object_Account\add(), Alternc_Api_Object_Domain\add(), Alternc_Api_Object_Ftp\add(), Alternc_Api_Object_Mysql\add(), aliasAdd(), aliasDel(), Alternc_Api_Object_Policy\check(), Alternc_Api_Object_Mail\create(), Alternc_Api_Object_Account\del(), Alternc_Api_Object_Domain\del(), Alternc_Api_Object_Ftp\del(), Alternc_Api_Object_Mysql\del(), Alternc_Api_Object_Mail\delete(), Alternc_Api_Object_Mail\disable(), Alternc_Api_Object_Mail\enable(), finalize(), Alternc_Api_Object_Account\find(), Alternc_Api_Object_Ftp\find(), Alternc_Api_Object_Mysql\find(), Alternc_Api_Object_Policy\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Mail\get(), Alternc_Api_Object_Subdomain\get(), Alternc_Api_Object_Mail\getAll(), getCertificate(), importCert(), Alternc_Api_Object_Mail\isAvailable(), Alternc_Api_Object_Ftp\isFtp(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Account\lock(), Alternc_Api_Object_Mysql\lock(), newCsr(), Alternc_Api_Object_Mail\passwd(), Alternc_Api_Object_Subdomain\set(), Alternc_Api_Object_Account\setAdmin(), Alternc_Api_Object_Mysql\setAdmin(), share(), Alternc_Api_Object_Mail\undelete(), Alternc_Api_Object_Account\unlock(), Alternc_Api_Object_Mysql\unlock(), Alternc_Api_Object_Account\unsetAdmin(), Alternc_Api_Object_Mysql\unsetAdmin(), Alternc_Api_Object_Account\update(), Alternc_Api_Object_Domain\update(), Alternc_Api_Object_Ftp\update(), Alternc_Api_Object_Mail\update(), Alternc_Api_Object_Mysql\update(), and Alternc_Api_Object_Policy\update().

finalize()

Alternc_Api_Object_Ssl::finalize

(

$options

)

API Method from legacy class finalize()

Parameters

$options

a hash with parameters transmitted to legacy call second part of the new_csr() call, finalize a certificate creation id = ID of the certificate to finalize in the table. crt = Certificate data chain = Chained Certificate date (not mandatory)

Returns

Alternc_Api_Response the ID of the updated certificate in the table.

Definition at line 124 of file Ssl.php.

                              {
    if (!isset($options["id"]) || !intval($options["id"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: ID") );
    }
    if (!isset($options["crt"]) || !is_string($options["crt"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: CRT") );
    }
    if (isset($options["chain"])) {
      if (!is_string($options["chain"])) {
   return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Invalid argument: CHAIN") );
      }
    } else {
      $options["chain"]="";
    }
 
    $certid=$this->ssl->finalize(intval($options["id"]),$options["crt"],$options["chain"]);
    if ($certid===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $certid) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

getCertificate()

Alternc_Api_Object_Ssl::getCertificate

(

$options

)

API Method from legacy class get_certificate()

Parameters

$options

a hash with parameters transmitted to legacy call id = the ID of the certificate in the certifiate table to get

Returns

Alternc_Api_Response whose content is a hash with all informations for that certificate

Definition at line 55 of file Ssl.php.

                                    {
    if (!isset($options["id"]) || !intval($options["id"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: ID") );
    }
    $certinfo=$this->ssl->get_certificate(intval($options["id"]));
    if ($certinfo===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $certinfo) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

getList()

Alternc_Api_Object_Ssl::getList

(

$options

)

API Method from legacy class get_list()

Parameters

$options

a hash with parameters transmitted to legacy call filter = the kind of ssl certificates to show or not show

Returns

Alternc_Api_Response whose content is an array of hashes containing all corresponding certificates informations

Definition at line 22 of file Ssl.php.

                             {
    if (isset($options["filter"]) && intval($options["filter"])) {
      $filter=intval($options["filter"]);
    } else {
      $filter=null;
    }
    $ssllist=$this->ssl->get_list($filter);
    return new Alternc_Api_Response( array("content" => $ssllist) );
  }

importCert()

Alternc_Api_Object_Ssl::importCert

(

$options

)

API Method from legacy class import_cert()

Parameters

$options

a hash with parameters transmitted to legacy call key, crt, chain = key and crt (both mandatory) and chain (not mandatory) to import

Returns

Alternc_Api_Response the ID of the newly created certificate in the table.

Definition at line 93 of file Ssl.php.

                                {
    if (!isset($options["key"]) || !is_string($options["key"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: KEY") );
    }
    if (!isset($options["crt"]) || !is_string($options["crt"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: CRT") );
    }
    if (isset($options["chain"])) {
      if (!is_string($options["chain"])) {
   return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Invalid argument: CHAIN") );
      }
    } else {
      $options["chain"]="";
    }
 
    $certid=$this->ssl->import_cert($options["key"],$options["crt"],$options["chain"]);
    if ($certid===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $certid) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

newCsr()

Alternc_Api_Object_Ssl::newCsr

(

$options

)

API Method from legacy class new_csr()

Parameters

$options

a hash with parameters transmitted to legacy call fqdn = the DNS name to create a CSR to

Returns

Alternc_Api_Response whose content is the CSR ID in the certificate database

Definition at line 38 of file Ssl.php.

                            {
    if (!isset($options["fqdn"]) || !is_string($options["fqdn"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: FQDN") );
    }
    $certid=$this->ssl->new_csr($options["fqdn"]);
    if ($certid===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $certid) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

offsetAndCount()

Alternc_Api_Legacyobject::offsetAndCount (   $options,   $max  )

protectedinherited

ensure that offset & count are set properly from $options.

Definition at line 45 of file Legacyobject.php.

                                                      {
        $offset = -1;
        $count = -1;
        if (isset($options["count"]))
            $count = intval($options["count"]);
        if (isset($options["offset"]))
            $offset = intval($options["offset"]);
        if ($offset != -1 || $count != -1) {
            if ($offset < 0 || $offset > $max)
                $offset = 0;
            if ($count < 0 || $count > 1000)
                $count = 1000;
        }
        return array($offset, $count);
    }

Referenced by Alternc_Api_Object_Account\find(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Ftp\find(), and Alternc_Api_Object_Mysql\find().

share()

Alternc_Api_Object_Ssl::share

(

$options

)

API Method from legacy class share()

Parameters

$options

a hash with parameters transmitted to legacy call id = the ID of the certificate to share or unshare action = boolean telling to share(true) or unshare(false) this certificate

Returns

Alternc_Api_Response true.

Definition at line 73 of file Ssl.php.

                           {
    if (!isset($options["id"]) || !intval($options["id"])) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: ID") );
    }
    if (!isset($options["action"]) ) {
      return new Alternc_Api_Response( array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: ACTION") );
    }
    $isok=$this->ssl->share(intval($options["id"]), (intval($options["action"]))? true : false );
    if ($isok===false) {
      return $this->alterncLegacyErrorManager();
    }
    return new Alternc_Api_Response( array("content" => $isok) );
  }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

Member Data Documentation

$admin

Alternc_Api_Legacyobject::$admin

protectedinherited

Definition at line 11 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

$cuid

Alternc_Api_Legacyobject::$cuid

protectedinherited

Definition at line 12 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Subdomain\get(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Mail\login(), and Alternc_Api_Object_Subdomain\set().

$db

Alternc_Api_Legacyobject::$db

protectedinherited

Definition at line 14 of file Legacyobject.php.

$isAdmin

Alternc_Api_Legacyobject::$isAdmin

protectedinherited

Definition at line 13 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

$ssl

Alternc_Api_Object_Ssl::$ssl

protected

Definition at line 8 of file Ssl.php.

Referenced by __construct().

ERR_ALTERNC_FUNCTION

const Alternc_Api_Legacyobject::ERR_ALTERNC_FUNCTION = 111202

inherited

Definition at line 17 of file Legacyobject.php.

ERR_INVALID_ARGUMENT

const Alternc_Api_Legacyobject::ERR_INVALID_ARGUMENT = 111201

inherited

Definition at line 16 of file Legacyobject.php.

ERR_NOT_FOUND

const Alternc_Api_Legacyobject::ERR_NOT_FOUND = 111203

inherited

Definition at line 18 of file Legacyobject.php.

---

The documentation for this class was generated from the following file:

• lib/Alternc/Api/Object/Ssl.php