* Resource holding the key. *
* @return void No value is returned. */ function openssl_pkey_free ($key) {} /** * (PHP 4 >= 4.2.0, PHP 5)* You can finetune the key generation (such as specifying the number of * bits) using configargs. See * openssl_csr_new for more information about * configargs. *
* @return resource a resource identifier for the pkey on success, or FALSE on * error. */ function openssl_pkey_new (array $configargs = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)* The key is optionally protected by passphrase. *
* @param array $configargs [optional]* configargs can be used to fine-tune the export * process by specifying and/or overriding options for the openssl * configuration file. See openssl_csr_new for more * information about configargs. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_pkey_export ($key, &$out, $passphrase = null, array $configargs = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)* Path to the output file. *
* @param string $passphrase [optional]* The key can be optionally protected by a * passphrase. *
* @param array $configargs [optional]* configargs can be used to fine-tune the export * process by specifying and/or overriding options for the openssl * configuration file. See openssl_csr_new for more * information about configargs. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_pkey_export_to_file ($key, $outfilename, $passphrase = null, array $configargs = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)* key can be one of the following: * a string having the format * file://path/to/file.pem. The named file must * contain a PEM encoded certificate/private key (it may contain both). * @param string $passphrase [optional]
* The optional parameter passphrase must be used * if the specified key is encrypted (protected by a passphrase). *
* @return resource a positive key resource identifier on success, or FALSE on error. */ function openssl_pkey_get_private ($key, $passphrase = "") {} /** * (PHP 4 >= 4.2.0, PHP 5)
* certificate can be one of the following:
* an X.509 certificate resource
* @return resource a positive key resource identifier on success, or FALSE on error.
*/
function openssl_pkey_get_public ($certificate) {}
/**
* (PHP 5 >= 5.2.0)
* Returns an array with the key details
* @link http://php.net/manual/en/function.openssl-pkey-get-details.php
* @param resource $key
* Resource holding the key. *
* @return array an array with the key details in success or FALSE in failure. * Returned array has indexes bits (number of bits), * key (string representation of the public key) and * type (type of the key which is one of * OPENSSL_KEYTYPE_RSA, * OPENSSL_KEYTYPE_DSA, * OPENSSL_KEYTYPE_DH, * OPENSSL_KEYTYPE_EC or -1 meaning unknown). * *
* Depending on the key type used, additional details may be returned. Note that
* some elements may not always be available.
*/
function openssl_pkey_get_details ($key) {}
/**
* (PHP 4 >= 4.0.4, PHP 5)
* Free key resource
* @link http://php.net/manual/en/function.openssl-free-key.php
* @param resource $key_identifier
* @return void No value is returned.
*/
function openssl_free_key ($key_identifier) {}
/**
* (PHP 4 >= 4.0.4, PHP 5)
* Alias of openssl_pkey_get_private
* @link http://php.net/manual/en/function.openssl-get-privatekey.php
* @param $key
* @param $passphrase [optional]
*/
function openssl_get_privatekey ($key, $passphrase) {}
/**
* (PHP 4 >= 4.0.4, PHP 5)
* Alias of openssl_pkey_get_public
* @link http://php.net/manual/en/function.openssl-get-publickey.php
* @param $cert
*/
function openssl_get_publickey ($cert) {}
/**
* (PHP 4 >= 4.0.6, PHP 5)
* Parse an X.509 certificate and return a resource identifier for
it
* @link http://php.net/manual/en/function.openssl-x509-read.php
* @param mixed $x509certdata
* @return resource a resource identifier on success or FALSE on failure.
*/
function openssl_x509_read ($x509certdata) {}
/**
* (PHP 4 >= 4.0.6, PHP 5)
* Free certificate resource
* @link http://php.net/manual/en/function.openssl-x509-free.php
* @param resource $x509cert
* @return void No value is returned.
*/
function openssl_x509_free ($x509cert) {}
/**
* (PHP 4 >= 4.0.6, PHP 5)
* Parse an X509 certificate and return the information as an array
* @link http://php.net/manual/en/function.openssl-x509-parse.php
* @param mixed $x509cert
* @param bool $shortnames [optional]
* shortnames controls how the data is indexed in the * array - if shortnames is TRUE (the default) then * fields will be indexed with the short name form, otherwise, the long name * form will be used - e.g.: CN is the shortname form of commonName. *
* @return array The structure of the returned data is (deliberately) not * yet documented, as it is still subject to change. */ function openssl_x509_parse ($x509cert, $shortnames = true) {} /** * (PHP 4 >= 4.0.6, PHP 5)* The examined certificate. *
* @param int $purpose*
| Constant | *Description | *
| X509_PURPOSE_SSL_CLIENT | *Can the certificate be used for the client side of an SSL * connection? | *
| X509_PURPOSE_SSL_SERVER | *Can the certificate be used for the server side of an SSL * connection? | *
| X509_PURPOSE_NS_SSL_SERVER | *Can the cert be used for Netscape SSL server? | *
| X509_PURPOSE_SMIME_SIGN | *Can the cert be used to sign S/MIME email? | *
| X509_PURPOSE_SMIME_ENCRYPT | *Can the cert be used to encrypt S/MIME email? | *
| X509_PURPOSE_CRL_SIGN | *Can the cert be used to sign a certificate revocation list * (CRL)? | *
| X509_PURPOSE_ANY | *Can the cert be used for Any/All purposes? | *
* cainfo should be an array of trusted CA files/dirs * as described in Certificate * Verification. *
* @param string $untrustedfile [optional]* If specified, this should be the name of a PEM encoded file holding * certificates that can be used to help verify the certificate, although * no trust is placed in the certificates that come from that file. *
* @return int TRUE if the certificate can be used for the intended purpose, * FALSE if it cannot, or -1 on error. */ function openssl_x509_checkpurpose ($x509cert, $purpose, array $cainfo = 'array()', $untrustedfile = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)* The certificate. *
* @param mixed $key* The private key. *
* @return bool TRUE if key is the private key that * corresponds to cert, or FALSE otherwise. */ function openssl_x509_check_private_key ($cert, $key) {} /** * (PHP 4 >= 4.2.0, PHP 5)* On success, this will hold the PEM. *
* @param bool $notext [optional] The optional parameter notext affects * the verbosity of the output; if it is FALSE, then additional human-readable * information is included in the output. The default value of * notext is TRUE. * * @return bool TRUE on success or FALSE on failure. */ function openssl_x509_export ($x509, &$output, $notext = '&true;') {} /** * (PHP 4 >= 4.2.0, PHP 5)* Path to the output file. *
* @param bool $notext [optional] The optional parameter notext affects * the verbosity of the output; if it is FALSE, then additional human-readable * information is included in the output. The default value of * notext is TRUE. * * @return bool TRUE on success or FALSE on failure. */ function openssl_x509_export_to_file ($x509, $outfilename, $notext = '&true;') {} /** * (PHP 5 >= 5.2.2)* On success, this will hold the PKCS#12. *
* @param mixed $priv_key* Private key component of PKCS#12 file. *
* @param string $pass* Encryption password for unlocking the PKCS#12 file. *
* @param array $args [optional] * @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs12_export ($x509, &$out, $priv_key, $pass, array $args = null) {} /** * (PHP 5 >= 5.2.2)* Path to the output file. *
* @param mixed $priv_key* Private key component of PKCS#12 file. *
* @param string $pass* Encryption password for unlocking the PKCS#12 file. *
* @param array $args [optional] * @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs12_export_to_file ($x509, $filename, $priv_key, $pass, array $args = null) {} /** * (PHP 5 >= 5.2.2)* On success, this will hold the Certificate Store Data. *
* @param string $pass* Encryption password for unlocking the PKCS#12 file. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs12_read ($pkcs12, array &$certs, $pass) {} /** * (PHP 4 >= 4.2.0, PHP 5)* The Distinguished Name to be used in the certificate. *
* @param resource $privkey* privkey should be set to a private key that was * previously generated by openssl_pkey_new (or * otherwise obtained from the other openssl_pkey family of functions). * The corresponding public portion of the key will be used to sign the * CSR. *
* @param array $configargs [optional]* By default, the information in your system openssl.conf * is used to initialize the request; you can specify a configuration file * section by setting the config_section_section key of * configargs. You can also specify an alternative * openssl configuration file by setting the value of the * config key to the path of the file you want to use. * The following keys, if present in configargs * behave as their equivalents in the openssl.conf, as * listed in the table below. *
| configargs key | *type | *openssl.conf equivalent | *description | *
| digest_alg | *string | *default_md | *Selects which digest method to use | *
| x509_extensions | *string | *x509_extensions | *Selects which extensions should be used when creating an x509 * certificate | *
| req_extensions | *string | *req_extensions | *Selects which extensions should be used when creating a CSR | *
| private_key_bits | *integer | *default_bits | *Specifies how many bits should be used to generate a private * key | *
| private_key_type | *integer | *none | *Specifies the type of private key to create. This can be one * of OPENSSL_KEYTYPE_DSA, * OPENSSL_KEYTYPE_DH or * OPENSSL_KEYTYPE_RSA. * The default value is OPENSSL_KEYTYPE_RSA which * is currently the only supported key type. * | *
| encrypt_key | *boolean | *encrypt_key | *Should an exported key (with passphrase) be encrypted? | *
| encrypt_key_cipher | *integer | *none | ** One of cipher constants. * | *
* extraattribs is used to specify additional * configuration options for the CSR. Both dn and * extraattribs are associative arrays whose keys are * converted to OIDs and applied to the relevant part of the request. *
* @return mixed the CSR. */ function openssl_csr_new (array $dn, &$privkey, array $configargs = null, array $extraattribs = null) {} /** * (PHP 4 >= 4.2.0, PHP 5)* Path to the output file. *
* @param bool $notext [optional] The optional parameter notext affects * the verbosity of the output; if it is FALSE, then additional human-readable * information is included in the output. The default value of * notext is TRUE. * * @return bool TRUE on success or FALSE on failure. */ function openssl_csr_export_to_file ($csr, $outfilename, $notext = true) {} /** * (PHP 4 >= 4.2.0, PHP 5)* A CSR previously generated by openssl_csr_new. * It can also be the path to a PEM encoded CSR when specified as * file://path/to/csr or an exported string generated * by openssl_csr_export. *
* @param mixed $cacert* The generated certificate will be signed by cacert. * If cacert is NULL, the generated certificate * will be a self-signed certificate. *
* @param mixed $priv_key* priv_key is the private key that corresponds to * cacert. *
* @param int $days* days specifies the length of time for which the * generated certificate will be valid, in days. *
* @param array $configargs [optional]* You can finetune the CSR signing by configargs. * See openssl_csr_new for more information about * configargs. *
* @param int $serial [optional]* An optional the serial number of issued certificate. If not specified * it will default to 0. *
* @return resource an x509 certificate resource on success, FALSE on failure. */ function openssl_csr_sign ($csr, $cacert, $priv_key, $days, array $configargs = null, $serial = 0) {} /** * (PHP 5 >= 5.2.0)* The data. *
* @param string $method* The digest method. *
* @param bool $raw_output [optional]* Setting to TRUE will return as raw output data, otherwise the return * value is binhex encoded. *
* @return string the digested hash value on success or FALSE on failure. */ function openssl_digest ($data, $method, $raw_output = false) {} /** * (PHP 5 >= 5.3.0)* The data. *
* @param string $method* The cipher method. *
* @param string $password* The password. *
* @param bool $raw_output [optional]* Setting to TRUE will return as raw output data, otherwise the return * value is base64 encoded. *
* @param string $iv [optional]* A non-NULL Initialization Vector. *
* @return string the encrypted string on success or FALSE on failure. */ function openssl_encrypt ($data, $method, $password, $raw_output = false, $iv = "") {} /** * (PHP 5 >= 5.3.0)* The data. *
* @param string $method* The cipher method. *
* @param string $password* The password. *
* @param bool $raw_input [optional]* Setting to TRUE will take a raw encoded string, * otherwise a base64 string is assumed for the * data parameter. *
* @param string $iv [optional]* A non-NULL Initialization Vector. *
* @return string The decrypted string on success or FALSE on failure. */ function openssl_decrypt ($data, $method, $password, $raw_input = false, $iv = "") {} /** * (PHP 5 >= PHP 5.3.3)* The method. *
* @return int the cipher length on success, or FALSE on failure. */ function openssl_cipher_iv_length ($method) {} /** * (PHP 4 >= 4.0.4, PHP 5)* If the call was successful the signature is returned in * signature. *
* @param mixed $priv_key_id * @param int $signature_alg [optional]* For more information see the list of Signature Algorithms. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_sign ($data, &$signature, $priv_key_id, $signature_alg = 'OPENSSL_ALGO_SHA1') {} /** * (PHP 4 >= 4.0.4, PHP 5)* For more information see the list of Signature Algorithms. *
* @return int 1 if the signature is correct, 0 if it is incorrect, and * -1 on error. */ function openssl_verify ($data, $signature, $pub_key_id, $signature_alg = 'OPENSSL_ALGO_SHA1') {} /** * (PHP 4 >= 4.0.4, PHP 5)* If the call is successful the opened data is returned in this * parameter. *
* @param string $env_key * @param mixed $priv_key_id * @param string $method [optional] * @return bool TRUE on success or FALSE on failure. */ function openssl_open ($sealed_data, &$open_data, $env_key, $priv_key_id, $method = null) {} /** * (PHP 4 >= 4.0.6, PHP 5)* Path to the message. *
* @param int $flags* flags can be used to affect how the signature is * verified - see PKCS7 constants * for more information. *
* @param string $outfilename [optional]* If the outfilename is specified, it should be a * string holding the name of a file into which the certificates of the * persons that signed the messages will be stored in PEM format. *
* @param array $cainfo [optional]* If the cainfo is specified, it should hold * information about the trusted CA certificates to use in the verification * process - see certificate * verification for more information about this parameter. *
* @param string $extracerts [optional]* If the extracerts is specified, it is the filename * of a file containing a bunch of certificates to use as untrusted CAs. *
* @param string $content [optional]* You can specify a filename with content that will * be filled with the verified data, but with the signature information * stripped. *
* @return mixed TRUE if the signature is verified, FALSE if it is not correct * (the message has been tampered with, or the signing certificate is invalid), * or -1 on error. */ function openssl_pkcs7_verify ($filename, $flags, $outfilename = null, array $cainfo = null, $extracerts = null, $content = null) {} /** * (PHP 4 >= 4.0.6, PHP 5)* The decrypted message is written to the file specified by * outfilename. *
* @param mixed $recipcert * @param mixed $recipkey [optional] * @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs7_decrypt ($infilename, $outfilename, $recipcert, $recipkey = null) {} /** * (PHP 4 >= 4.0.6, PHP 5)* headers is an array of headers that * will be prepended to the data after it has been signed (see * openssl_pkcs7_encrypt for more information about * the format of this parameter). *
* @param int $flags [optional]* flags can be used to alter the output - see PKCS7 constants. *
* @param string $extracerts [optional]* extracerts specifies the name of a file containing * a bunch of extra certificates to include in the signature which can for * example be used to help the recipient to verify the certificate that you used. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs7_sign ($infilename, $outfilename, $signcert, $privkey, array $headers, $flags = 'PKCS7_DETACHED', $extracerts = null) {} /** * (PHP 4 >= 4.0.6, PHP 5)* Either a lone X.509 certificate, or an array of X.509 certificates. *
* @param array $headers* headers is an array of headers that * will be prepended to the data after it has been encrypted. *
** headers can be either an associative array * keyed by header name, or an indexed array, where each element contains * a single header line. *
* @param int $flags [optional]* flags can be used to specify options that affect * the encoding process - see PKCS7 * constants. *
* @param int $cipherid [optional]* One of cipher constants. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_pkcs7_encrypt ($infile, $outfile, $recipcerts, array $headers, $flags = 0, $cipherid = 'OPENSSL_CIPHER_RC2_40') {} /** * (PHP 4 >= 4.0.6, PHP 5)* padding can be one of * OPENSSL_PKCS1_PADDING, * OPENSSL_NO_PADDING. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_private_encrypt ($data, &$crypted, $key, $padding = 'OPENSSL_PKCS1_PADDING') {} /** * (PHP 4 >= 4.0.6, PHP 5)* key must be the private key corresponding that * was used to encrypt the data. *
* @param int $padding [optional]* padding can be one of * OPENSSL_PKCS1_PADDING, * OPENSSL_SSLV23_PADDING, * OPENSSL_PKCS1_OAEP_PADDING, * OPENSSL_NO_PADDING. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_private_decrypt ($data, &$decrypted, $key, $padding = 'OPENSSL_PKCS1_PADDING') {} /** * (PHP 4 >= 4.0.6, PHP 5)* This will hold the result of the encryption. *
* @param mixed $key* The public key. *
* @param int $padding [optional]* padding can be one of * OPENSSL_PKCS1_PADDING, * OPENSSL_SSLV23_PADDING, * OPENSSL_PKCS1_OAEP_PADDING, * OPENSSL_NO_PADDING. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_public_encrypt ($data, &$crypted, $key, $padding = 'OPENSSL_PKCS1_PADDING') {} /** * (PHP 4 >= 4.0.6, PHP 5)* key must be the public key corresponding that * was used to encrypt the data. *
* @param int $padding [optional]* padding can be one of * OPENSSL_PKCS1_PADDING, * OPENSSL_NO_PADDING. *
* @return bool TRUE on success or FALSE on failure. */ function openssl_public_decrypt ($data, &$decrypted, $key, $padding = 'OPENSSL_PKCS1_PADDING') {} /** * (PHP 5 >= 5.3.0)* Set to TRUE if digest aliases should be included within the * returned array. *
* @return array An array of available digest methods. */ function openssl_get_md_methods ($aliases = false) {} /** * (PHP 5 >= 5.3.0)* Set to TRUE if cipher aliases should be included within the * returned array. *
* @return array An array of available cipher methods. */ function openssl_get_cipher_methods ($aliases = false) {} /** * (No version information available, might only be in SVN)* Public key *
* @param resource $dh_key* DH key *
* @return string computed key on success or FALSE on failure. */ function openssl_dh_compute_key ($pub_key, $dh_key) {} /** * (PHP 5 >= 5.3.0)* The length of the desired string of bytes. Must be a positive integer. PHP will * try to cast this parameter to a non-null integer to use it. *
* @param bool $crypto_strong [optional]* If passed into the function, this will hold a boolean value that determines * if the algorithm used was "cryptographically strong", e.g., safe for usage with GPG, * passwords, etc. TRUE if it did, otherwise FALSE *
* @return string the generated string of bytes on success, or FALSE on failure. */ function openssl_random_pseudo_bytes ($length, &$crypto_strong = null) {} /** * (PHP 4 >= 4.0.6, PHP 5)