diff --git a/language/predefined/exception/clone.xml b/language/predefined/exception/clone.xml index db137381dcf3..c59bdae69034 100644 --- a/language/predefined/exception/clone.xml +++ b/language/predefined/exception/clone.xml @@ -8,10 +8,7 @@ &reftitle.description; - - private voidException::__clone - - + Exceptions do not support cloning; this method exists only to prevent it. diff --git a/language/predefined/exception/construct.xml b/language/predefined/exception/construct.xml index 2b907ed6487d..9b90510c7b12 100644 --- a/language/predefined/exception/construct.xml +++ b/language/predefined/exception/construct.xml @@ -8,12 +8,7 @@ &reftitle.description; - - public Exception::__construct - stringmessage"" - intcode0 - Throwablenullprevious&null; - + Constructs the Exception. diff --git a/language/predefined/exception/getcode.xml b/language/predefined/exception/getcode.xml index e625d44fb10e..88bb342d040e 100644 --- a/language/predefined/exception/getcode.xml +++ b/language/predefined/exception/getcode.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public intException::getCode - - + Returns the Exception code. diff --git a/language/predefined/exception/getfile.xml b/language/predefined/exception/getfile.xml index 0e347c7b1d13..d201c80519a7 100644 --- a/language/predefined/exception/getfile.xml +++ b/language/predefined/exception/getfile.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public stringException::getFile - - + Get the name of the file in which the exception was created. diff --git a/language/predefined/exception/getline.xml b/language/predefined/exception/getline.xml index 9c4ebdfb672b..c086b5c7729c 100644 --- a/language/predefined/exception/getline.xml +++ b/language/predefined/exception/getline.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public intException::getLine - - + Get line number where the exception was created. diff --git a/language/predefined/exception/getmessage.xml b/language/predefined/exception/getmessage.xml index 52d28cc40043..21d306579bd9 100644 --- a/language/predefined/exception/getmessage.xml +++ b/language/predefined/exception/getmessage.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public stringException::getMessage - - + Returns the Exception message. diff --git a/language/predefined/exception/getprevious.xml b/language/predefined/exception/getprevious.xml index 03943d4cbe50..a0224f5452ec 100644 --- a/language/predefined/exception/getprevious.xml +++ b/language/predefined/exception/getprevious.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public ThrowablenullException::getPrevious - - + Returns previous Throwable (which had been passed as the third parameter of Exception::__construct). diff --git a/language/predefined/exception/gettrace.xml b/language/predefined/exception/gettrace.xml index f632ef33db04..1c4b6a89483c 100644 --- a/language/predefined/exception/gettrace.xml +++ b/language/predefined/exception/gettrace.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public arrayException::getTrace - - + Returns the Exception stack trace. diff --git a/language/predefined/exception/gettraceasstring.xml b/language/predefined/exception/gettraceasstring.xml index 5033c4bebbe9..29fbb263c210 100644 --- a/language/predefined/exception/gettraceasstring.xml +++ b/language/predefined/exception/gettraceasstring.xml @@ -8,10 +8,7 @@ &reftitle.description; - - final public stringException::getTraceAsString - - + Returns the Exception stack trace as a string. diff --git a/language/predefined/exception/tostring.xml b/language/predefined/exception/tostring.xml index f9dd6583ad6d..8bdc4a20c4fd 100644 --- a/language/predefined/exception/tostring.xml +++ b/language/predefined/exception/tostring.xml @@ -8,10 +8,7 @@ &reftitle.description; - - public stringException::__toString - - + Returns the string representation of the exception. diff --git a/reference/openssl/functions/openssl-cipher-iv-length.xml b/reference/openssl/functions/openssl-cipher-iv-length.xml index 21d4598d105e..b45e91715a38 100644 --- a/reference/openssl/functions/openssl-cipher-iv-length.xml +++ b/reference/openssl/functions/openssl-cipher-iv-length.xml @@ -8,10 +8,7 @@ &reftitle.description; - - intfalseopenssl_cipher_iv_length - stringcipher_algo - + Gets the cipher initialization vector (iv) length. diff --git a/reference/openssl/functions/openssl-cipher-key-length.xml b/reference/openssl/functions/openssl-cipher-key-length.xml index 069f8159244f..72b59cbcad50 100644 --- a/reference/openssl/functions/openssl-cipher-key-length.xml +++ b/reference/openssl/functions/openssl-cipher-key-length.xml @@ -7,10 +7,7 @@ &reftitle.description; - - intfalseopenssl_cipher_key_length - stringcipher_algo - + Gets the cipher key length. diff --git a/reference/openssl/functions/openssl-cms-decrypt.xml b/reference/openssl/functions/openssl-cms-decrypt.xml index 27fbc552fdd2..4a84dc875878 100644 --- a/reference/openssl/functions/openssl-cms-decrypt.xml +++ b/reference/openssl/functions/openssl-cms-decrypt.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_cms_decrypt - stringinput_filename - stringoutput_filename - #[\SensitiveParameter]OpenSSLCertificatestringcertificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringnullprivate_key&null; - intencodingOPENSSL_ENCODING_SMIME - + Decrypts a CMS message. diff --git a/reference/openssl/functions/openssl-cms-encrypt.xml b/reference/openssl/functions/openssl-cms-encrypt.xml index b6508b26d7b7..567e97b83cfb 100644 --- a/reference/openssl/functions/openssl-cms-encrypt.xml +++ b/reference/openssl/functions/openssl-cms-encrypt.xml @@ -8,16 +8,7 @@ &reftitle.description; - - boolopenssl_cms_encrypt - stringinput_filename - stringoutput_filename - OpenSSLCertificatearraystringcertificate - arraynullheaders - intflags0 - intencodingOPENSSL_ENCODING_SMIME - stringintcipher_algoOPENSSL_CIPHER_AES_128_CBC - + This function encrypts content to one or more recipients, based on the certificates that are passed to it. diff --git a/reference/openssl/functions/openssl-cms-read.xml b/reference/openssl/functions/openssl-cms-read.xml index 29866a2ecf5d..36e7e192a38d 100644 --- a/reference/openssl/functions/openssl-cms-read.xml +++ b/reference/openssl/functions/openssl-cms-read.xml @@ -9,11 +9,7 @@ &reftitle.description; - - boolopenssl_cms_read - stringinput_filename - arraycertificates - + Performs the exact analog to openssl_pkcs7_read. diff --git a/reference/openssl/functions/openssl-cms-sign.xml b/reference/openssl/functions/openssl-cms-sign.xml index e3eef16471bb..ff3dc2c81366 100644 --- a/reference/openssl/functions/openssl-cms-sign.xml +++ b/reference/openssl/functions/openssl-cms-sign.xml @@ -8,17 +8,7 @@ &reftitle.description; - - boolopenssl_cms_sign - stringinput_filename - stringoutput_filename - OpenSSLCertificatestringcertificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - arraynullheaders - intflags0 - intencodingOPENSSL_ENCODING_SMIME - stringnulluntrusted_certificates_filename&null; - + This function signs a file with an X.509 certificate and key. diff --git a/reference/openssl/functions/openssl-cms-verify.xml b/reference/openssl/functions/openssl-cms-verify.xml index c547ff03a17b..5e3e96a3c1ec 100644 --- a/reference/openssl/functions/openssl-cms-verify.xml +++ b/reference/openssl/functions/openssl-cms-verify.xml @@ -9,18 +9,7 @@ &reftitle.description; - - boolopenssl_cms_verify - stringinput_filename - intflags0 - stringnullcertificates&null; - arrayca_info[] - stringnulluntrusted_certificates_filename&null; - stringnullcontent&null; - stringnullpk7&null; - stringnullsigfile&null; - intencodingOPENSSL_ENCODING_SMIME - + This function verifies a CMS signature, either attached or detached, with the specified encoding. diff --git a/reference/openssl/functions/openssl-csr-export-to-file.xml b/reference/openssl/functions/openssl-csr-export-to-file.xml index d6454056e2e8..5e612c2209c9 100644 --- a/reference/openssl/functions/openssl-csr-export-to-file.xml +++ b/reference/openssl/functions/openssl-csr-export-to-file.xml @@ -8,12 +8,7 @@ &reftitle.description; - - boolopenssl_csr_export_to_file - OpenSSLCertificateSigningRequeststringcsr - stringoutput_filename - boolno_text&true; - + openssl_csr_export_to_file takes the Certificate Signing Request represented by csr and saves it diff --git a/reference/openssl/functions/openssl-csr-export.xml b/reference/openssl/functions/openssl-csr-export.xml index 4872864125db..e2a36cd9d898 100644 --- a/reference/openssl/functions/openssl-csr-export.xml +++ b/reference/openssl/functions/openssl-csr-export.xml @@ -8,12 +8,7 @@ &reftitle.description; - - boolopenssl_csr_export - OpenSSLCertificateSigningRequeststringcsr - stringoutput - boolno_text&true; - + openssl_csr_export takes the Certificate Signing Request represented by csr and stores it in diff --git a/reference/openssl/functions/openssl-csr-get-public-key.xml b/reference/openssl/functions/openssl-csr-get-public-key.xml index 22aaa549eabe..bb0bb50738cb 100644 --- a/reference/openssl/functions/openssl-csr-get-public-key.xml +++ b/reference/openssl/functions/openssl-csr-get-public-key.xml @@ -8,11 +8,7 @@ &reftitle.description; - - OpenSSLAsymmetricKeyfalseopenssl_csr_get_public_key - OpenSSLCertificateSigningRequeststringcsr - boolshort_names&true; - + openssl_csr_get_public_key extracts the public key from csr and prepares it for use by other functions. diff --git a/reference/openssl/functions/openssl-csr-get-subject.xml b/reference/openssl/functions/openssl-csr-get-subject.xml index 7cc1ccd3b2ca..1358ea8267ad 100644 --- a/reference/openssl/functions/openssl-csr-get-subject.xml +++ b/reference/openssl/functions/openssl-csr-get-subject.xml @@ -8,11 +8,7 @@ &reftitle.description; - - arrayfalseopenssl_csr_get_subject - OpenSSLCertificateSigningRequeststringcsr - boolshort_names&true; - + openssl_csr_get_subject returns subject distinguished name information encoded in the csr diff --git a/reference/openssl/functions/openssl-csr-new.xml b/reference/openssl/functions/openssl-csr-new.xml index dccaac79374f..b1fc65e99161 100644 --- a/reference/openssl/functions/openssl-csr-new.xml +++ b/reference/openssl/functions/openssl-csr-new.xml @@ -8,13 +8,7 @@ &reftitle.description; - - OpenSSLCertificateSigningRequestboolopenssl_csr_new - arraydistinguished_names - #[\SensitiveParameter]OpenSSLAsymmetricKeynullprivate_key - arraynulloptions&null; - arraynullextra_attributes&null; - + openssl_csr_new generates a new CSR based on the information provided by distinguished_names. diff --git a/reference/openssl/functions/openssl-csr-sign.xml b/reference/openssl/functions/openssl-csr-sign.xml index 607f5a0ffe24..0840ebc682e8 100644 --- a/reference/openssl/functions/openssl-csr-sign.xml +++ b/reference/openssl/functions/openssl-csr-sign.xml @@ -8,16 +8,7 @@ &reftitle.description; - - OpenSSLCertificatefalseopenssl_csr_sign - OpenSSLCertificateSigningRequeststringcsr - OpenSSLCertificatestringnullca_certificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - intdays - arraynulloptions&null; - intserial0 - stringnullserial_hex&null; - + openssl_csr_sign generates an x509 certificate from the given CSR. diff --git a/reference/openssl/functions/openssl-decrypt.xml b/reference/openssl/functions/openssl-decrypt.xml index 1db682383b1b..bb0919d8e3c1 100644 --- a/reference/openssl/functions/openssl-decrypt.xml +++ b/reference/openssl/functions/openssl-decrypt.xml @@ -8,16 +8,7 @@ &reftitle.description; - - stringfalseopenssl_decrypt - stringdata - stringcipher_algo - #[\SensitiveParameter]stringpassphrase - intoptions0 - stringiv"" - stringnulltag&null; - stringaad"" - + Takes a raw or base64 encoded string and decrypts it using a given method and passphrase. diff --git a/reference/openssl/functions/openssl-dh-compute-key.xml b/reference/openssl/functions/openssl-dh-compute-key.xml index 5b71bb5fadd6..548022e8658e 100644 --- a/reference/openssl/functions/openssl-dh-compute-key.xml +++ b/reference/openssl/functions/openssl-dh-compute-key.xml @@ -8,11 +8,7 @@ &reftitle.description; - - stringfalseopenssl_dh_compute_key - stringpublic_key - #[\SensitiveParameter]OpenSSLAsymmetricKeyprivate_key - + The shared secret returned by openssl_dh_compute_key is often used as an encryption key to secretly communicate with a remote party. diff --git a/reference/openssl/functions/openssl-digest.xml b/reference/openssl/functions/openssl-digest.xml index b48101256f7d..0b2e496a597d 100644 --- a/reference/openssl/functions/openssl-digest.xml +++ b/reference/openssl/functions/openssl-digest.xml @@ -8,12 +8,7 @@ &reftitle.description; - - stringfalseopenssl_digest - stringdata - stringdigest_algo - boolbinary&false; - + Computes a digest hash value for the given data using a given method, and returns a raw or binhex encoded string. diff --git a/reference/openssl/functions/openssl-encrypt.xml b/reference/openssl/functions/openssl-encrypt.xml index b9e2bf8335da..122998b6f733 100644 --- a/reference/openssl/functions/openssl-encrypt.xml +++ b/reference/openssl/functions/openssl-encrypt.xml @@ -8,17 +8,7 @@ &reftitle.description; - - stringfalseopenssl_encrypt - #[\SensitiveParameter]stringdata - stringcipher_algo - #[\SensitiveParameter]stringpassphrase - intoptions0 - stringiv"" - stringtag&null; - stringaad"" - inttag_length16 - + Encrypts given data with given method and passphrase, returns a raw or base64 encoded string diff --git a/reference/openssl/functions/openssl-error-string.xml b/reference/openssl/functions/openssl-error-string.xml index b64b3de14666..899a4623b718 100644 --- a/reference/openssl/functions/openssl-error-string.xml +++ b/reference/openssl/functions/openssl-error-string.xml @@ -8,10 +8,7 @@ &reftitle.description; - - stringfalseopenssl_error_string - - + openssl_error_string returns the last error from the openSSL library. Error messages are queued, so this function should be diff --git a/reference/openssl/functions/openssl-free-key.xml b/reference/openssl/functions/openssl-free-key.xml index 500292162bd3..ec42349e86e7 100644 --- a/reference/openssl/functions/openssl-free-key.xml +++ b/reference/openssl/functions/openssl-free-key.xml @@ -12,11 +12,7 @@ &reftitle.description; - - #[\Deprecated(since: '8.0', message: 'as OpenSSLAsymmetricKey objects are freed automatically')] - voidopenssl_free_key - OpenSSLAsymmetricKeykey - + openssl_free_key frees the key associated with the specified key from memory. diff --git a/reference/openssl/functions/openssl-get-cert-locations.xml b/reference/openssl/functions/openssl-get-cert-locations.xml index 66d5a2f0c452..1a0415e6e2a0 100644 --- a/reference/openssl/functions/openssl-get-cert-locations.xml +++ b/reference/openssl/functions/openssl-get-cert-locations.xml @@ -9,10 +9,7 @@ &reftitle.description; - - arrayopenssl_get_cert_locations - - + openssl_get_cert_locations returns an array with information about the available certificate locations that will be searched diff --git a/reference/openssl/functions/openssl-get-cipher-methods.xml b/reference/openssl/functions/openssl-get-cipher-methods.xml index b4267369d416..29ff060b3bae 100644 --- a/reference/openssl/functions/openssl-get-cipher-methods.xml +++ b/reference/openssl/functions/openssl-get-cipher-methods.xml @@ -9,10 +9,7 @@ &reftitle.description; - - arrayopenssl_get_cipher_methods - boolaliases&false; - + Gets a list of available cipher methods. diff --git a/reference/openssl/functions/openssl-get-curve-names.xml b/reference/openssl/functions/openssl-get-curve-names.xml index 637bbbce4143..ca83adc1d1d9 100644 --- a/reference/openssl/functions/openssl-get-curve-names.xml +++ b/reference/openssl/functions/openssl-get-curve-names.xml @@ -8,10 +8,7 @@ &reftitle.description; - - arrayfalseopenssl_get_curve_names - - + Gets the list of available curve names for use in Elliptic curve cryptography (ECC) for public/private key operations. The two most widely diff --git a/reference/openssl/functions/openssl-get-md-methods.xml b/reference/openssl/functions/openssl-get-md-methods.xml index c61371a99528..4a5fcf5e6a7c 100644 --- a/reference/openssl/functions/openssl-get-md-methods.xml +++ b/reference/openssl/functions/openssl-get-md-methods.xml @@ -9,10 +9,7 @@ &reftitle.description; - - arrayopenssl_get_md_methods - boolaliases&false; - + Gets a list of available digest methods. diff --git a/reference/openssl/functions/openssl-open.xml b/reference/openssl/functions/openssl-open.xml index 12c104c88ee0..b8555bb1ca1a 100644 --- a/reference/openssl/functions/openssl-open.xml +++ b/reference/openssl/functions/openssl-open.xml @@ -8,15 +8,7 @@ &reftitle.description; - - boolopenssl_open - stringdata - #[\SensitiveParameter]stringoutput - stringencrypted_key - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - stringcipher_algo - stringnulliv&null; - + openssl_open opens (decrypts) data using an envelope key that is decrypted from encrypted_key using diff --git a/reference/openssl/functions/openssl-password-hash.xml b/reference/openssl/functions/openssl-password-hash.xml index 96f33a6b5cdb..7cc2e6d123ca 100644 --- a/reference/openssl/functions/openssl-password-hash.xml +++ b/reference/openssl/functions/openssl-password-hash.xml @@ -7,12 +7,7 @@ &reftitle.description; - - stringopenssl_password_hash - stringalgo - #[\SensitiveParameter]stringpassword - arrayoptions[] - + Creates a password hash using OpenSSL's Argon2 implementation. This is an alternative to password_hash that uses OpenSSL as diff --git a/reference/openssl/functions/openssl-password-verify.xml b/reference/openssl/functions/openssl-password-verify.xml index f2c4d61bf4ab..6fd1371aab6b 100644 --- a/reference/openssl/functions/openssl-password-verify.xml +++ b/reference/openssl/functions/openssl-password-verify.xml @@ -7,12 +7,7 @@ &reftitle.description; - - boolopenssl_password_verify - stringalgo - #[\SensitiveParameter]stringpassword - stringhash - + Verifies that a password matches a hash created by openssl_password_hash. diff --git a/reference/openssl/functions/openssl-pbkdf2.xml b/reference/openssl/functions/openssl-pbkdf2.xml index babf75c33e5f..4455c29a863b 100644 --- a/reference/openssl/functions/openssl-pbkdf2.xml +++ b/reference/openssl/functions/openssl-pbkdf2.xml @@ -8,14 +8,7 @@ &reftitle.description; - - stringfalseopenssl_pbkdf2 - #[\SensitiveParameter]stringpassword - stringsalt - intkey_length - intiterations - stringdigest_algo"sha1" - + openssl_pbkdf2 computes PBKDF2 (Password-Based Key Derivation Function 2), a key derivation function defined in PKCS5 v2. diff --git a/reference/openssl/functions/openssl-pkcs12-export-to-file.xml b/reference/openssl/functions/openssl-pkcs12-export-to-file.xml index 59f5d9df6451..9c2299987397 100644 --- a/reference/openssl/functions/openssl-pkcs12-export-to-file.xml +++ b/reference/openssl/functions/openssl-pkcs12-export-to-file.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs12_export_to_file - OpenSSLCertificatestringcertificate - stringoutput_filename - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - #[\SensitiveParameter]stringpassphrase - arrayoptions[] - + openssl_pkcs12_export_to_file stores certificate into a file named by diff --git a/reference/openssl/functions/openssl-pkcs12-export.xml b/reference/openssl/functions/openssl-pkcs12-export.xml index db7013f6b6bd..6951cba2b829 100644 --- a/reference/openssl/functions/openssl-pkcs12-export.xml +++ b/reference/openssl/functions/openssl-pkcs12-export.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs12_export - OpenSSLCertificatestringcertificate - stringoutput - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - #[\SensitiveParameter]stringpassphrase - arrayoptions[] - + openssl_pkcs12_export stores certificate into a string named by diff --git a/reference/openssl/functions/openssl-pkcs12-read.xml b/reference/openssl/functions/openssl-pkcs12-read.xml index aa8ec52d5f46..d54760151ca8 100644 --- a/reference/openssl/functions/openssl-pkcs12-read.xml +++ b/reference/openssl/functions/openssl-pkcs12-read.xml @@ -8,12 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs12_read - stringpkcs12 - arraycertificates - #[\SensitiveParameter]stringpassphrase - + openssl_pkcs12_read parses the PKCS#12 certificate store supplied by pkcs12 into an array named diff --git a/reference/openssl/functions/openssl-pkcs7-decrypt.xml b/reference/openssl/functions/openssl-pkcs7-decrypt.xml index d73916271310..d51bd0dc46a2 100644 --- a/reference/openssl/functions/openssl-pkcs7-decrypt.xml +++ b/reference/openssl/functions/openssl-pkcs7-decrypt.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs7_decrypt - stringinput_filename - stringoutput_filename - #[\SensitiveParameter]OpenSSLCertificatestringcertificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringnullprivate_key&null; - + Decrypts the S/MIME encrypted message contained in the file specified by input_filename using the certificate and its diff --git a/reference/openssl/functions/openssl-pkcs7-encrypt.xml b/reference/openssl/functions/openssl-pkcs7-encrypt.xml index c61bda50904d..10e05f2a5ca0 100644 --- a/reference/openssl/functions/openssl-pkcs7-encrypt.xml +++ b/reference/openssl/functions/openssl-pkcs7-encrypt.xml @@ -8,15 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs7_encrypt - stringinput_filename - stringoutput_filename - OpenSSLCertificatearraystringcertificate - arraynullheaders - intflags0 - intcipher_algoOPENSSL_CIPHER_AES_128_CBC - + openssl_pkcs7_encrypt takes the contents of the file named input_filename and encrypts them using an RC2 diff --git a/reference/openssl/functions/openssl-pkcs7-read.xml b/reference/openssl/functions/openssl-pkcs7-read.xml index 35b662a35579..76c962b9011a 100644 --- a/reference/openssl/functions/openssl-pkcs7-read.xml +++ b/reference/openssl/functions/openssl-pkcs7-read.xml @@ -8,11 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs7_read - stringdata - arraycertificates - + diff --git a/reference/openssl/functions/openssl-pkcs7-sign.xml b/reference/openssl/functions/openssl-pkcs7-sign.xml index f533fedd1902..02152e8f1e5c 100644 --- a/reference/openssl/functions/openssl-pkcs7-sign.xml +++ b/reference/openssl/functions/openssl-pkcs7-sign.xml @@ -8,16 +8,7 @@ &reftitle.description; - - boolopenssl_pkcs7_sign - stringinput_filename - stringoutput_filename - OpenSSLCertificatestringcertificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - arraynullheaders - intflagsPKCS7_DETACHED - stringnulluntrusted_certificates_filename&null; - + openssl_pkcs7_sign takes the contents of the file named input_filename and signs them using the diff --git a/reference/openssl/functions/openssl-pkcs7-verify.xml b/reference/openssl/functions/openssl-pkcs7-verify.xml index e31d0356b49e..b632f7bd9eb3 100644 --- a/reference/openssl/functions/openssl-pkcs7-verify.xml +++ b/reference/openssl/functions/openssl-pkcs7-verify.xml @@ -8,16 +8,7 @@ &reftitle.description; - - boolintopenssl_pkcs7_verify - stringinput_filename - intflags - stringnullsigners_certificates_filename&null; - arrayca_info[] - stringnulluntrusted_certificates_filename&null; - stringnullcontent&null; - stringnulloutput_filename&null; - + openssl_pkcs7_verify reads the S/MIME message contained in the given file and examines the digital signature. diff --git a/reference/openssl/functions/openssl-pkey-derive.xml b/reference/openssl/functions/openssl-pkey-derive.xml index 24188aeb4065..5f708c3c81d3 100644 --- a/reference/openssl/functions/openssl-pkey-derive.xml +++ b/reference/openssl/functions/openssl-pkey-derive.xml @@ -8,12 +8,7 @@ &reftitle.description; - - stringfalseopenssl_pkey_derive - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - intkey_length0 - + openssl_pkey_derive takes a set of a public_key and private_key and derives a shared secret, for either DH or EC keys. diff --git a/reference/openssl/functions/openssl-pkey-export-to-file.xml b/reference/openssl/functions/openssl-pkey-export-to-file.xml index 0fad499d40b4..ff30219f45b0 100644 --- a/reference/openssl/functions/openssl-pkey-export-to-file.xml +++ b/reference/openssl/functions/openssl-pkey-export-to-file.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolopenssl_pkey_export_to_file - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringkey - stringoutput_filename - #[\SensitiveParameter]stringnullpassphrase&null; - arraynulloptions&null; - + openssl_pkey_export_to_file saves an ascii-armoured (PEM encoded) rendition of key into the file named diff --git a/reference/openssl/functions/openssl-pkey-export.xml b/reference/openssl/functions/openssl-pkey-export.xml index 5ed6cf0cfb61..119a58a6be36 100644 --- a/reference/openssl/functions/openssl-pkey-export.xml +++ b/reference/openssl/functions/openssl-pkey-export.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolopenssl_pkey_export - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringkey - stringoutput - #[\SensitiveParameter]stringnullpassphrase&null; - arraynulloptions&null; - + openssl_pkey_export exports key as a PEM encoded string and stores it into diff --git a/reference/openssl/functions/openssl-pkey-free.xml b/reference/openssl/functions/openssl-pkey-free.xml index 14cf2bfefc47..6d7ef831323b 100644 --- a/reference/openssl/functions/openssl-pkey-free.xml +++ b/reference/openssl/functions/openssl-pkey-free.xml @@ -12,11 +12,7 @@ &reftitle.description; - - #[\Deprecated(since: '8.0', message: 'as OpenSSLAsymmetricKey objects are freed automatically')] - voidopenssl_pkey_free - OpenSSLAsymmetricKeykey - + ¬e.resource-migration-8.0-dead-function; This function frees a private key created by diff --git a/reference/openssl/functions/openssl-pkey-get-details.xml b/reference/openssl/functions/openssl-pkey-get-details.xml index 438aae356730..1608462cc823 100644 --- a/reference/openssl/functions/openssl-pkey-get-details.xml +++ b/reference/openssl/functions/openssl-pkey-get-details.xml @@ -8,10 +8,7 @@ &reftitle.description; - - arrayfalseopenssl_pkey_get_details - OpenSSLAsymmetricKeykey - + This function returns the key details (bits, key, type). diff --git a/reference/openssl/functions/openssl-pkey-get-private.xml b/reference/openssl/functions/openssl-pkey-get-private.xml index c04411bf76cf..ddaf80d63977 100644 --- a/reference/openssl/functions/openssl-pkey-get-private.xml +++ b/reference/openssl/functions/openssl-pkey-get-private.xml @@ -8,11 +8,7 @@ &reftitle.description; - - OpenSSLAsymmetricKeyfalseopenssl_pkey_get_private - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - #[\SensitiveParameter]stringnullpassphrase&null; - + openssl_pkey_get_private parses private_key and prepares it for use by other functions. diff --git a/reference/openssl/functions/openssl-pkey-get-public.xml b/reference/openssl/functions/openssl-pkey-get-public.xml index 0ac48a6a4ecc..9d061694b53f 100644 --- a/reference/openssl/functions/openssl-pkey-get-public.xml +++ b/reference/openssl/functions/openssl-pkey-get-public.xml @@ -8,10 +8,7 @@ &reftitle.description; - - OpenSSLAsymmetricKeyfalseopenssl_pkey_get_public - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - + openssl_pkey_get_public extracts the public key from public_key and prepares it for use by other diff --git a/reference/openssl/functions/openssl-pkey-new.xml b/reference/openssl/functions/openssl-pkey-new.xml index 6960b3e310a8..29a3facf88a4 100644 --- a/reference/openssl/functions/openssl-pkey-new.xml +++ b/reference/openssl/functions/openssl-pkey-new.xml @@ -8,10 +8,7 @@ &reftitle.description; - - OpenSSLAsymmetricKeyfalseopenssl_pkey_new - arraynulloptions&null; - + openssl_pkey_new generates a new private key. diff --git a/reference/openssl/functions/openssl-private-decrypt.xml b/reference/openssl/functions/openssl-private-decrypt.xml index 93667da2deb6..9db06b5b423c 100644 --- a/reference/openssl/functions/openssl-private-decrypt.xml +++ b/reference/openssl/functions/openssl-private-decrypt.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_private_decrypt - stringdata - #[\SensitiveParameter]stringdecrypted_data - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - intpaddingOPENSSL_PKCS1_PADDING - stringnulldigest_algo&null; - + openssl_private_decrypt decrypts data that was previously encrypted via diff --git a/reference/openssl/functions/openssl-private-encrypt.xml b/reference/openssl/functions/openssl-private-encrypt.xml index 7c7cac59bbdb..dbf76c1c4db6 100644 --- a/reference/openssl/functions/openssl-private-encrypt.xml +++ b/reference/openssl/functions/openssl-private-encrypt.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolopenssl_private_encrypt - #[\SensitiveParameter]stringdata - stringencrypted_data - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - intpaddingOPENSSL_PKCS1_PADDING - + openssl_private_encrypt encrypts data with private private_key and stores the result into diff --git a/reference/openssl/functions/openssl-public-decrypt.xml b/reference/openssl/functions/openssl-public-decrypt.xml index 55b51a1564b1..221c07c374a2 100644 --- a/reference/openssl/functions/openssl-public-decrypt.xml +++ b/reference/openssl/functions/openssl-public-decrypt.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolopenssl_public_decrypt - stringdata - #[\SensitiveParameter]stringdecrypted_data - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - intpaddingOPENSSL_PKCS1_PADDING - + openssl_public_decrypt decrypts data that was previous encrypted via diff --git a/reference/openssl/functions/openssl-public-encrypt.xml b/reference/openssl/functions/openssl-public-encrypt.xml index 4a4b36eb9544..b368810ca6d9 100644 --- a/reference/openssl/functions/openssl-public-encrypt.xml +++ b/reference/openssl/functions/openssl-public-encrypt.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_public_encrypt - #[\SensitiveParameter]stringdata - stringencrypted_data - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - intpaddingOPENSSL_PKCS1_PADDING - stringnulldigest_algo&null; - + openssl_public_encrypt encrypts data with public public_key and stores the result into diff --git a/reference/openssl/functions/openssl-random-pseudo-bytes.xml b/reference/openssl/functions/openssl-random-pseudo-bytes.xml index 923ece93b869..72be532f2431 100644 --- a/reference/openssl/functions/openssl-random-pseudo-bytes.xml +++ b/reference/openssl/functions/openssl-random-pseudo-bytes.xml @@ -8,11 +8,7 @@ &reftitle.description; - - stringopenssl_random_pseudo_bytes - intlength - boolstrong_result&null; - + Generates a string of pseudo-random bytes, with the number of bytes determined by the length parameter. diff --git a/reference/openssl/functions/openssl-seal.xml b/reference/openssl/functions/openssl-seal.xml index 03d4c0714e38..3a702fd437db 100644 --- a/reference/openssl/functions/openssl-seal.xml +++ b/reference/openssl/functions/openssl-seal.xml @@ -8,15 +8,7 @@ &reftitle.description; - - intfalseopenssl_seal - #[\SensitiveParameter]stringdata - stringsealed_data - arrayencrypted_keys - arraypublic_key - stringcipher_algo - stringiv&null; - + openssl_seal seals (encrypts) data using the specified cipher_algo with a randomly generated secret key. The key is diff --git a/reference/openssl/functions/openssl-sign.xml b/reference/openssl/functions/openssl-sign.xml index 3e5f7dbdea6c..8d0c913b7b79 100644 --- a/reference/openssl/functions/openssl-sign.xml +++ b/reference/openssl/functions/openssl-sign.xml @@ -8,14 +8,7 @@ &reftitle.description; - - boolopenssl_sign - stringdata - stringsignature - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - stringintalgorithmOPENSSL_ALGO_SHA1 - intpadding0 - + openssl_sign computes a signature for the specified data by generating a cryptographic diff --git a/reference/openssl/functions/openssl-spki-export-challenge.xml b/reference/openssl/functions/openssl-spki-export-challenge.xml index b8c9132e896c..699d776cfbef 100644 --- a/reference/openssl/functions/openssl-spki-export-challenge.xml +++ b/reference/openssl/functions/openssl-spki-export-challenge.xml @@ -8,10 +8,7 @@ &reftitle.description; - - stringfalseopenssl_spki_export_challenge - stringspki - + Exports challenge from encoded signed public key and challenge diff --git a/reference/openssl/functions/openssl-spki-export.xml b/reference/openssl/functions/openssl-spki-export.xml index ccaaf95413a3..72c03229caff 100644 --- a/reference/openssl/functions/openssl-spki-export.xml +++ b/reference/openssl/functions/openssl-spki-export.xml @@ -8,10 +8,7 @@ &reftitle.description; - - stringfalseopenssl_spki_export - stringspki - + Exports PEM formatted public key from encoded signed public key and challenge diff --git a/reference/openssl/functions/openssl-spki-new.xml b/reference/openssl/functions/openssl-spki-new.xml index 1804fdd2f9e6..9b6f8c081b44 100644 --- a/reference/openssl/functions/openssl-spki-new.xml +++ b/reference/openssl/functions/openssl-spki-new.xml @@ -8,12 +8,7 @@ &reftitle.description; - - stringfalseopenssl_spki_new - #[\SensitiveParameter]OpenSSLAsymmetricKeyprivate_key - stringchallenge - intdigest_algoOPENSSL_ALGO_MD5 - + Generates a signed public key and challenge using specified hashing algorithm diff --git a/reference/openssl/functions/openssl-spki-verify.xml b/reference/openssl/functions/openssl-spki-verify.xml index a5b869819f41..6ba0f5d2cefa 100644 --- a/reference/openssl/functions/openssl-spki-verify.xml +++ b/reference/openssl/functions/openssl-spki-verify.xml @@ -8,10 +8,7 @@ &reftitle.description; - - boolopenssl_spki_verify - stringspki - + Validates the supplied signed public key and challenge diff --git a/reference/openssl/functions/openssl-verify.xml b/reference/openssl/functions/openssl-verify.xml index b85f3a24150e..fe68394af8f5 100644 --- a/reference/openssl/functions/openssl-verify.xml +++ b/reference/openssl/functions/openssl-verify.xml @@ -8,14 +8,7 @@ &reftitle.description; - - intfalseopenssl_verify - stringdata - stringsignature - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - stringintalgorithmOPENSSL_ALGO_SHA1 - intpadding0 - + openssl_verify verifies that the signature is correct for the specified diff --git a/reference/openssl/functions/openssl-x509-check-private-key.xml b/reference/openssl/functions/openssl-x509-check-private-key.xml index 1a269f6f0b06..3fa6fb5db8ec 100644 --- a/reference/openssl/functions/openssl-x509-check-private-key.xml +++ b/reference/openssl/functions/openssl-x509-check-private-key.xml @@ -8,11 +8,7 @@ &reftitle.description; - - boolopenssl_x509_check_private_key - OpenSSLCertificatestringcertificate - #[\SensitiveParameter]OpenSSLAsymmetricKeyOpenSSLCertificatearraystringprivate_key - + Checks whether the given private_key is the private key that corresponds to certificate. diff --git a/reference/openssl/functions/openssl-x509-checkpurpose.xml b/reference/openssl/functions/openssl-x509-checkpurpose.xml index 17bdd4f6f4c7..2e6421a37585 100644 --- a/reference/openssl/functions/openssl-x509-checkpurpose.xml +++ b/reference/openssl/functions/openssl-x509-checkpurpose.xml @@ -8,13 +8,7 @@ &reftitle.description; - - boolintopenssl_x509_checkpurpose - OpenSSLCertificatestringcertificate - intpurpose - arrayca_info[] - stringnulluntrusted_certificates_file&null; - + openssl_x509_checkpurpose examines a certificate to see if it can be used for the specified purpose. diff --git a/reference/openssl/functions/openssl-x509-export-to-file.xml b/reference/openssl/functions/openssl-x509-export-to-file.xml index 763904a1d1c1..36502c87c27a 100644 --- a/reference/openssl/functions/openssl-x509-export-to-file.xml +++ b/reference/openssl/functions/openssl-x509-export-to-file.xml @@ -8,12 +8,7 @@ &reftitle.description; - - boolopenssl_x509_export_to_file - OpenSSLCertificatestringcertificate - stringoutput_filename - boolno_text&true; - + openssl_x509_export_to_file stores certificate into a file named by diff --git a/reference/openssl/functions/openssl-x509-export.xml b/reference/openssl/functions/openssl-x509-export.xml index f88f5b864612..87cc4566155f 100644 --- a/reference/openssl/functions/openssl-x509-export.xml +++ b/reference/openssl/functions/openssl-x509-export.xml @@ -8,12 +8,7 @@ &reftitle.description; - - boolopenssl_x509_export - OpenSSLCertificatestringcertificate - stringoutput - boolno_text&true; - + openssl_x509_export stores certificate into a string named by diff --git a/reference/openssl/functions/openssl-x509-fingerprint.xml b/reference/openssl/functions/openssl-x509-fingerprint.xml index a14921dcda9f..8b7250cc16bd 100644 --- a/reference/openssl/functions/openssl-x509-fingerprint.xml +++ b/reference/openssl/functions/openssl-x509-fingerprint.xml @@ -8,12 +8,7 @@ &reftitle.description; - - stringfalseopenssl_x509_fingerprint - OpenSSLCertificatestringcertificate - stringdigest_algo"sha1" - boolbinary&false; - + openssl_x509_fingerprint returns the digest of certificate as a string. diff --git a/reference/openssl/functions/openssl-x509-free.xml b/reference/openssl/functions/openssl-x509-free.xml index 08999730d831..c476a4ad20f1 100644 --- a/reference/openssl/functions/openssl-x509-free.xml +++ b/reference/openssl/functions/openssl-x509-free.xml @@ -12,11 +12,7 @@ &reftitle.description; - - #[\Deprecated(since: '8.0', message: 'as OpenSSLCertificate objects are freed automatically')] - voidopenssl_x509_free - OpenSSLCertificatecertificate - + ¬e.resource-migration-8.0-dead-function; openssl_x509_free frees the certificate associated diff --git a/reference/openssl/functions/openssl-x509-parse.xml b/reference/openssl/functions/openssl-x509-parse.xml index 1b303ccdfb72..604c51501982 100644 --- a/reference/openssl/functions/openssl-x509-parse.xml +++ b/reference/openssl/functions/openssl-x509-parse.xml @@ -8,11 +8,7 @@ &reftitle.description; - - arrayfalseopenssl_x509_parse - OpenSSLCertificatestringcertificate - boolshort_names&true; - + openssl_x509_parse returns information about the supplied certificate, including fields such as subject diff --git a/reference/openssl/functions/openssl-x509-read.xml b/reference/openssl/functions/openssl-x509-read.xml index 9fe2459e1d73..d5b5974dcbd2 100644 --- a/reference/openssl/functions/openssl-x509-read.xml +++ b/reference/openssl/functions/openssl-x509-read.xml @@ -9,10 +9,7 @@ &reftitle.description; - - OpenSSLCertificatefalseopenssl_x509_read - OpenSSLCertificatestringcertificate - + openssl_x509_read parses the certificate supplied by certificate and returns an OpenSSLCertificate object for diff --git a/reference/openssl/functions/openssl-x509-verify.xml b/reference/openssl/functions/openssl-x509-verify.xml index 5394c7170f31..88c77f58d44a 100644 --- a/reference/openssl/functions/openssl-x509-verify.xml +++ b/reference/openssl/functions/openssl-x509-verify.xml @@ -8,11 +8,7 @@ &reftitle.description; - - intopenssl_x509_verify - OpenSSLCertificatestringcertificate - OpenSSLAsymmetricKeyOpenSSLCertificatearraystringpublic_key - + openssl_x509_verify verifies that the certificate certificate was signed by the private