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)
    5. OpenSSL Module (PHP)
    6. OpenSSL S/MIME Module (CLI)
      1. Description
      2. Public Methods
      3. Demo
    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

OpenSSL S/MIME Module (CLI)

Table of Contents

  1. Description
    1. Public Methods
      1. Demo

        Description

        The \setasign\SetaPDF2\Signer\Signature\Module\OpenSslCli module uses the S/MIME utility of OpenSSL to create the signature. 

        It allows you e.g. to define a specifc digest algorithm.  

        The utility will be executed by an exec() call.

        Public Methods

        getCertificate()

        Get the path to the signing certificate.

        getDigest()

        Get the digest algorithm.

        getExtraCertificates()

        Get the path of the file with additional certificates.

        getOpenSslPath()

        Get the path to the openssl binary.

        getPrivateKey()

        Get the path to the private key file.

        getPrivateKeyPassword()

        Get the private key password source.

        setCertificate()

        Set the path to the signing certificate.

        setDigest()

        Set the digest algorithm to use when signing.

        setExtraCertificates()

        Set the path to a file with additional certificates which will be included in the signature.

        setOpenSslPath()

        Set the path to the openssl binary.

        setPrivateKey()

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

        setPrivateKeyPassword()

        Set the private key password source.

        Demo

        PHP
        <?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Signer\Signature\Module\OpenSslCli as OpenSslCliModule;
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 OpenSslCliModule();
// load the certificate
$certificate = '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)