This module uses the functions of OpenSSL for generation and verification
of signatures and for sealing (encrypting) and opening (decrypting)
data_ OpenSSL offers many features that this module currently doesn't
support_ Some of these may be added in the future_
Requerimientos
In order to use the OpenSSL functions you need to install the OpenSSL package_
PHP_4_0_4pl1 requires OpenSSL >= 0_9_6, but PHP_4_0_5 and greater
will also work with OpenSSL >= 0_9_5_
Instalación
To use PHP's OpenSSL support you must also compile PHP __with_openssl[=DIR]_
Note to Win32 Users:
In order to enable this module on a Windows environment, you must copy
libeay32_dll from the DLL folder of the PHP/Win32 binary
package to the SYSTEM32 folder of your windows machine_ (Ex: C:\WINNT\SYSTEM32
or C:\WINDOWS\SYSTEM32)
Additionally, if you are planning to use the key generation and certificate
signing functions, you will need to install a valid
openssl_cnf on your system_ As of PHP 4_3_0, we
include a sample configuration file in the openssl of
our win32 binary distribution_ If you are using PHP 4_2_0 or later and are
missing the file, you can obtain it from the
OpenSSL home page or by downloading the PHP 4_3_0 release and using
the configuration file from there_
Note to Win32 Users:
PHP will search for the openssl_cnf using the
following logic:
the OPENSSL_CONF environmental variable, if
set, will be used as the path (including filename) of the configuration
file_
the SSLEAY_CONF environmental variable, if
set, will be used as the path (including filename) of the configuration
file_
The file openssl_cnf will be assumed to be
found in the default certificate area, as configured at the time that
the openssl DLL was compiled_ This is usually means that the default
filename is c:\usr\local\ssl\openssl_cnf_
In your installation, you need to decide whether to install the
configuration file at c:\usr\local\ssl\openssl_cnf or
whether to install it someplace else and use environmental variables
(possibly on a per_virtual_host basis) to locate the configuration file_
Note that it is possible to override the default path from the script using
the configargs of the functions that require a
configuration file_
Configuración en tiempo de
ejecución
Esta extensión no tiene directivas de
configuración en php_ini_
Tipos de recursos
Key/Certificate parameters
Quite a few of the openssl functions require a key or a certificate
parameter_ PHP 4_0_5 and earlier have to use a key or certificate
resource returned by one of the openssl_get_xxx functions_
Later versions may use one of the following methods:
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)
A string containing the content of a certificate/key, PEM encoded
For private keys, you may also use the syntax
array($key, $passphrase) where $key represents a
key specified using the file:// or textual content notation above, and
$passphrase represents a string containing the passphrase for that
private key
Certificate Verification
When calling a function that will verify a signature/certificate, the
cainfo parameter is an array containing file and
directory names that specify the locations of trusted CA files_ If a
directory is specified, then it must be a correctly formed hashed
directory as the openssl command would use_
Constantes predefinidas
Estas constantes están
definidas por esta extensión y estarán disponibles
solamente cuando la extensión ha sido o bien compilada dentro
de PHP o grabada dinámicamente en tiempo de ejecución_
The S/MIME functions make use of flags which are specified using a
bitfield which can include one or more of the following values:
Tabla 1_ PKCS7 CONSTANTS
Constant
Description
PKCS7_TEXT
adds text/plain content type headers to encrypted/signed
message_ If decrypting or verifying, it strips those headers from
the output _ if the decrypted or verified message is not of MIME type
text/plain then an error will occur_
PKCS7_BINARY
normally the input message is converted to "canonical" format
which is effectively using CR and LF as end of line: as required by
the S/MIME specification_ When this options is present, no
translation occurs_ This is useful when handling binary data which
may not be in MIME format_
PKCS7_NOINTERN
when verifying a message, certificates (if
any) included in the message are normally searched for the
signing certificate_ With this option only the
certificates specified in the extracerts
parameter of openssl_pkcs7_verify() are
used_ The supplied certificates can still be used as
untrusted CAs however_
PKCS7_NOVERIFY
do not verify the signers certificate of a signed
message_
PKCS7_NOCHAIN
do not chain verification of signers certificates: that is
don't use the certificates in the signed message as untrusted CAs_
PKCS7_NOCERTS
when signing a message the signer's certificate is normally
included _ with this option it is excluded_ This will reduce the
size of the signed message but the verifier must have a copy of the
signers certificate available locally (passed using the
extracerts to
openssl_pkcs7_verify() for example_
PKCS7_NOATTR
normally when a message is signed, a set of attributes are
included which include the signing time and the supported symmetric
algorithms_ With this option they are not included_
PKCS7_DETACHED
When signing a message, use cleartext signing with the MIME
type multipart/signed_ This is the default if the
flags parameter to
openssl_pkcs7_sign() if you do not specify any
flags_ If you turn this option off, the message will be signed using
opaque signing, which is more resistant to translation by mail relays
but cannot be read by mail agents that do not support S/MIME_