Index

  1. Getting Started
  2. The Main Class
  3. Signature Fields
  4. Signature Appearance Modules
  5. Signature Modules
    1. Overview
    2. Keys in PKCS#12 Format (.pfx / .p12)
    3. PAdES Module (PHP)
    4. CMS Module (PHP)
      1. Description
      2. Public Methods
      3. Demo
    5. OpenSSL Module (PHP)
    6. OpenSSL S/MIME Module (CLI)
    7. OpenSSL CMS Module (CLI)
    8. Additional Modules
    9. Individual Module
    10. External Implementation
  6. Timestamp Modules
  7. Asynchronous Signature Workflow
  8. Sign Several Times
  9. Signing PDF Forms
  10. Long-Term Validation (LTV)
  11. Trust Settings
  12. Migrating
  13. LTV (pre-release)
  14. API Reference

CMS Module (PHP)

Table of Contents

  1. Description
    1. Public Methods
      1. Demo

        Description

        The \setasign\SetaPDF2\Signer\Signature\Module\Cms module makes use of an implementation of the CMS (Cryptographic Message Syntax) for digital signatures in plain PHP. It makes use of explicit signed attributes and builds the basis for individual signature modules that need the option to exert influence on the CMS structure.

        The module makes use of the PHP build-in OpenSSL function openssl_sign() to create the final signature. It also gives you the opportunity to use all available digest algorithms. By default it uses SHA-256.

        The certificate needs to be passed as a string or file path and needs to be PEM (Base64) encoded.

        The private key data has to be passed as described here.

        Public Methods

        addCrl()

        Adds an CRL which will be embedded in the CMS structure.

        addOcspResponse()

        Adds an OCSP response which will be embedded in the CMS structure.

        getCertificate()

        Get the certificate value.

        getCms()

        Get the complete Cryptographic Message Syntax structure.

        getDataToSign()

        Get the data which needs to be digitally signed.

        getDigest()

        Get the digest algorithm.

        getParsedCertificate()

        Ensures a certificate parameter and parses it into an ASN.1 element object structure.

        setCertificate()

        Set the signing certificate (PEM).

        setDigest()

        Set the digest algorithm to use when signing.

        setExtraCertificates()

        Add additional certificates which are placed into the CMS structure.

        setPrivateKey()

        Set the the private key or a path to the private key file and password argument.

        setSignatureValue()

        Set the signature value.

        Demo

        PHP
        <?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Signer\Signature\Module\Cms as CmsModule;
use setasign\SetaPDF2\Signer\Signer;

require_once('library/SetaPDF/Autoload.php');

// create a writer
$writer = new HttpWriter('simple.pdf', true);
// create a new document instance
$document = Document::loadByFilename(
    'files/pdfs/tektown/Laboratory-Report.pdf', $writer
);

// create a signer instance
$signer = new Signer($document);

// set some signature properties
$signer->setReason('Testing CMS module');
$signer->setLocation('SetaPDF-Signer Manual');

// create a signature module
$module = new CmsModule();
// load the certificate
$certificate = 'file://files/certificates/setapdf-no-pw.pem';
$module->setCertificate($certificate);
$module->setPrivateKey([$certificate, '' /* no password */]);

// sign the document and send the final document to the initial writer
$signer->sign($module);
        © 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)