openssl_cms_sign

Sign a file.

openssl_cms_sign Function synopsis

openssl_cms_sign(
    string $input_filename,
    string $output_filename,
    OpenSSLCertificate|string $certificate,
    $private_key,
    ?array $headers,
    int $flags = 0,
    int $encoding = OPENSSL_ENCODING_SMIME,
    ?string $untrusted_certificates_filename = null
  ): bool

Parameters

$input_filename

Typestring

The name of the file to be signed.

$output_filename

Typestring

The name of the file to deposit the results.

$certificate

TypeOpenSSLCertificate|string

The signing certificate. See Key/Certificate parameters for a list of valid values.

$private_key

The key associated with $certificate. See Key/Certificate parameters for a list of valid values.

$headers

Type?array

An array of headers to be included in S/MIME output.

$flags

OptionalTypeintDefault value0

Flags to be passed to cms_sign.

$encoding

OptionalTypeintDefault valueOPENSSL_ENCODING_SMIME

The encoding of the output file. One of OPENSSL_ENCODING_SMIME, OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM.

$untrusted_certificates_filename

OptionalType?stringDefault valuenull

Intermediate certificates to be included in the signature.

Return value

Typebool

Returns true on success, false on failure