From 586ed53748c3c51a3c2c9e8a8920a31d9d06edbf Mon Sep 17 00:00:00 2001 From: Jason Gerfen Date: Mon, 31 Mar 2014 12:25:56 +0000 Subject: [PATCH] Documentation for PHP 5.6.0 Alpha3 release which implements PR in commit (http://git.php.net/?p=php-src.git;a=commit;h=8f56ac8401ed1c3e00b8fba3fb8e5efb565180c4) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333230 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../openssl-spki-export-challenge.xml | 104 +++++++++++++ .../openssl/functions/openssl-spki-export.xml | 108 +++++++++++++ .../openssl/functions/openssl-spki-new.xml | 146 ++++++++++++++++++ .../openssl/functions/openssl-spki-verify.xml | 109 +++++++++++++ 4 files changed, 467 insertions(+) create mode 100644 reference/openssl/functions/openssl-spki-export-challenge.xml create mode 100644 reference/openssl/functions/openssl-spki-export.xml create mode 100644 reference/openssl/functions/openssl-spki-new.xml create mode 100644 reference/openssl/functions/openssl-spki-verify.xml diff --git a/reference/openssl/functions/openssl-spki-export-challenge.xml b/reference/openssl/functions/openssl-spki-export-challenge.xml new file mode 100644 index 0000000000..1900749038 --- /dev/null +++ b/reference/openssl/functions/openssl-spki-export-challenge.xml @@ -0,0 +1,104 @@ + + + + + + openssl_spki_export_challenge + Exports the challenge assoicated with a signed public key and challenge + + + + &reftitle.description; + + stringopenssl_spki_export_challenge + stringspkac + + + Exports challenge from encoded signed public key and challenge + + + + + &reftitle.parameters; + + + spkac + + + Expects a valid signed public key and challenge + + + + + + + + &reftitle.returnvalues; + + Returns the associated challenge string or NULL on failure. + + + + + &reftitle.errors; + + Emits an E_WARNING level error if an invalid argument + is passed via the spkac parameter. + + + + + &reftitle.examples; + + <function>openssl-spki-export-challenge</function> example + + Extracts the associated challenge string or NULL on failure. + + + +]]> + + + + + + &reftitle.seealso; + + + openssl_spki_new + openssl_spki_verify + openssl_spki_export + openssl_md_method + openssl_csr_new + openssl_csr_sign + + + + + + + diff --git a/reference/openssl/functions/openssl-spki-export.xml b/reference/openssl/functions/openssl-spki-export.xml new file mode 100644 index 0000000000..5c1384ee8f --- /dev/null +++ b/reference/openssl/functions/openssl-spki-export.xml @@ -0,0 +1,108 @@ + + + + + + openssl_spki_export + Exports a valid PEM formatted public key signed public key and challenge + + + + &reftitle.description; + + stringopenssl_spki_export + stringspkac + + + Exports PEM formatted public key from encoded signed public key and challenge + + + + + &reftitle.parameters; + + + spkac + + + Expects a valid signed public key and challenge + + + + + + + + &reftitle.returnvalues; + + Returns the associated PEM formatted public key or NULL on failure. + + + + + &reftitle.errors; + + Emits an E_WARNING level error if an invalid argument + is passed via the spkac parameter. + + + + + &reftitle.examples; + + <function>openssl-spki-export</function> example + + Extracts the associated PEM formatted public key or NULL on failure. + + + +]]> + + + + + + &reftitle.seealso; + + + openssl_spki_new + openssl_spki_verify + openssl_spki_export_challenge + openssl_md_method + openssl_csr_new + openssl_csr_sign + + + + + + + diff --git a/reference/openssl/functions/openssl-spki-new.xml b/reference/openssl/functions/openssl-spki-new.xml new file mode 100644 index 0000000000..67c392c776 --- /dev/null +++ b/reference/openssl/functions/openssl-spki-new.xml @@ -0,0 +1,146 @@ + + + + + + openssl_spki_new + Generate a new signed public key and challenge + + + + &reftitle.description; + + stringopenssl_spki_new + resourceprivkey + stringchallenge + intalgorithm0 + + + Generates a signed public key and challenge using specified hashing algorithm + + + + + &reftitle.parameters; + + + 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. + + + + + challenge + + + The challenge associated to associate with the SPKAC + + + + + algorithm + + + The digest algorithm. See openssl_get_md_method(). + + + + + + + + &reftitle.returnvalues; + + Returns a signed public key and challenge string or NULL on failure. + + + + + &reftitle.errors; + + Emits an E_WARNING level error if an unknown signature algorithm + is passed via the algorithm parameter. + + + + + &reftitle.examples; + + <function>openssl-spki-new</function> example + + Generate a new SPKAC with the default digest (MD5) + + + +]]> + + &example.outputs.similar; + + + + + + + + &reftitle.seealso; + + + openssl_md_method + openssl_csr_new + openssl_csr_sign + + + + + + + diff --git a/reference/openssl/functions/openssl-spki-verify.xml b/reference/openssl/functions/openssl-spki-verify.xml new file mode 100644 index 0000000000..d081bb9986 --- /dev/null +++ b/reference/openssl/functions/openssl-spki-verify.xml @@ -0,0 +1,109 @@ + + + + + + openssl_spki_verify + Verifies a signed public key and challenge + + + + &reftitle.description; + + stringopenssl_spki_verify + stringspkac + + + Validates the supplied signed public key and challenge + + + + + &reftitle.parameters; + + + spkac + + + Expects a valid signed public key and challenge + + + + + + + + &reftitle.returnvalues; + + Returns a boolean on success or failure. + + + + + &reftitle.errors; + + Emits an E_WARNING level error if an invalid argument + is passed via the spkac parameter. + + + + + &reftitle.examples; + + <function>openssl-spki-verify</function> example + + Validates an existing signed public key and challenge + + + +]]> + + + + + + &reftitle.seealso; + + + openssl_spki_new + openssl_spki_export_challenge + openssl_spki_export + openssl_md_method + openssl_csr_new + openssl_csr_sign + + + + + + +