Index

  1. \setasign\SetaPDF2
    1. Core
      1. SecHandler
        1. PublicKey
        2. PublicKey
          1. Aes128
          2. Aes256
          3. Arcfour128
          4. Arcfour128Cf
          5. Recipient

setasign\SetaPDF2\Core\SecHandler\PublicKey

Arcfour128 Generator class for RC4 40 bit public-key security handler

File: /SetaPDF v2/Core/SecHandler/PublicKey/Arcfour128.php
Old class name (alias): \SetaPDF_Core_SecHandler_PublicKey_Arcfour128

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

PERM_OWNER

public const int \setasign\SetaPDF2\Core\SecHandler\PublicKey::PERM_OWNER = 2

Permission constant.

When set permits change of encryption and enables all other permissions.

See
  • PDF 32000-1:2008 - Table 24 - Public-Key security handler user access permissions

Properties

$_auth

protected bool \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_auth = false

Defines if this security handler is authenticated

$_authData

protected array \setasign\SetaPDF2\Core\SecHandler\PublicKey::$_authData = array(...)

An array holding authentication data.

$_authMode

protected ?string \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_authMode

The auth mode

Says who is authenticated: user or owner

$_cipherId

protected int \setasign\SetaPDF2\Core\SecHandler\PublicKey::$_cipherId = 7

The cipher id that is passed to openssl_pkcs7_encrypt().

See

$_document

protected \SetaPDF_Core_Document \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_document

The document to which this security handler is attached

$_encryptMetadata

protected bool \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_encryptMetadata = true

Metadata are encrypted or not

$_encryptionDictionary

protected \SetaPDF_Core_Type_Dictionary \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_encryptionDictionary

The encryption dictionary

$_encryptionKey

protected string \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_encryptionKey

The encryption key

$_keyLength

protected int \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_keyLength = 5

The key length in bytes

This value is still needed if crypt filters are in use:

  • It is needed to compute the encryption key.
  • It is needed to compute the O value It is NOT documented which key length should be used for this things if a crypt filter is in use.

$_streamAlgorithm

protected array \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_streamAlgorithm = array(...)

The algorithm key length to be used for en/decrypting stream

$_stringAlgorithm

protected array \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::$_stringAlgorithm = array(...)

The algorithm key length to be used for en/decrypting strings


Static Methods

create()

public static Arcfour128::create (): \SetaPDF_Core_SecHandler_PublicKey_Arcfour128

Create method for RC4 128 bit public-key security handler.

Parameters
$document : \SetaPDF_Core_Document
 
$recipients : \SetaPDF_Core_SecHandler_PublicKey_Recipient[]|\SetaPDF_Core_SecHandler_PublicKey_Recipient
 
Exceptions

Throws \Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

factory()

WARNING: This method is marked as deprecated!

Use self::create() instead

public static Arcfour128::factory (): \SetaPDF_Core_SecHandler_PublicKey_Arcfour128
Parameters
$document : \SetaPDF_Core_Document
 
$recipients : \SetaPDF_Core_SecHandler_PublicKey_Recipient[]|\SetaPDF_Core_SecHandler_PublicKey_Recipient
 
Exceptions

Throws \Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception


Methods

__construct()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::__construct (
\SetaPDF_Core_Document $document,
\SetaPDF_Core_Type_Dictionary $encryptionDictionary
)

The constructor.

Parameters
$document : \SetaPDF_Core_Document
 
$encryptionDictionary : \SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_cleanUp()

protected \setasign\SetaPDF2\Core\SecHandler\PublicKey::_cleanUp (
void
): void

Removes temporary files.

_computeEncryptionKey()

protected \setasign\SetaPDF2\Core\SecHandler\PublicKey::_computeEncryptionKey (
string[] $envelopes,
string $seed,
bool|true $encryptMetadata = true
): string

Computes the encryption key.

Parameters
$envelopes : string[]
 
$seed : string
 
$encryptMetadata : bool|true
 

_computeHashR6()

protected \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::_computeHashR6 (
string $data,
string $inputPassword,
string $userKey = ''
): string

Computes a hash for security handler revision 6.

Parameters
$data : string
 
$inputPassword : string
 
$userKey : string
 

_crypt()

protected \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::_crypt (
string $data,
array $algorithm,
\SetaPDF_Core_Type_IndirectObject $param = null,
bool $encrypt = true
): string

Encrypts or decrypts data using Algorithm 1 of the PDF specification.

Parameters
$data : string
 
$algorithm : array
 
$param : \SetaPDF_Core_Type_IndirectObject
 
$encrypt : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_prepareEnvelopes()

protected \setasign\SetaPDF2\Core\SecHandler\PublicKey::_prepareEnvelopes (): string[]

Prepares the PKCS#7 envelopes.

Parameters
$recipients : \SetaPDF_Core_SecHandler_PublicKey_Recipient[]
 
$seed : string
 
Exceptions

Throws \Exception

_preparePermission()

protected \setasign\SetaPDF2\Core\SecHandler\PublicKey::_preparePermission (
int $permissions
): string

Prepares permission flag.

Parameters
$permissions : int
 

auth()

public \setasign\SetaPDF2\Core\SecHandler\PublicKey::auth (
mixed $recipientCert = null,
mixed $recipientKey = null
): bool

Authenticate to the security handler with a certificate and private key.

Parameters
$recipientCert : mixed

See parameter $recipcert of openssl_pkcs7_decrypt().

$recipientKey : mixed

See parameter $recipkey of openssl_pkcs7_decrypt().

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \Exception

decryptStream()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::decryptStream (
string $data,
\SetaPDF_Core_Type_IndirectObject $param = null
): string

Decrypt a stream.

Parameters
$data : string
 
$param : \SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

decryptString()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::decryptString (
string $data,
\SetaPDF_Core_Type_IndirectObject $param = null
): string

Decrypt a string.

Parameters
$data : string
 
$param : \SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

encryptStream()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::encryptStream (
string $data,
\SetaPDF_Core_Type_IndirectObject $param = null
): string

Encrypt a stream.

Parameters
$data : string
 
$param : \SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

encryptString()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::encryptString (
string $data,
\SetaPDF_Core_Type_IndirectObject $param = null
): string

Encrypt a string.

Parameters
$data : string
 
$param : \SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getAuthMode()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getAuthMode (
void
): string

Get the auth method.

Return Values

"user", "owner" or an empty string if not authenticated.

getCipherId()

public \setasign\SetaPDF2\Core\SecHandler\PublicKey::getCipherId (
void
): int

Get the cipher id, that will be passed to openssl_pkcs7_encrypt().

See

getDocument()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getDocument (
void
): \SetaPDF_Core_Document

Returns the document instance of this security handler.

getEncryptMetadata()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getEncryptMetadata (
void
): bool

Returns true if the metadata are/will be encrypted.

getEncryptionDictionary()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getEncryptionDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Gets the encryption dictionary.

getEncryptionKey()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getEncryptionKey (
void
): string

Get the encryption key if known/authenticated.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getPdfVersion()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getPdfVersion (
void
): string

Get the PDF version, which is needed for the currently used encryption algorithm.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

getPermission()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getPermission (
int $permission
): bool

Queries if a permission is granted.

Parameters
$permission : int
 

getPermissions()

public \setasign\SetaPDF2\Core\SecHandler\PublicKey::getPermissions (
void
): int

Returns current permissions.

See

getStreamAlgorithm()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getStreamAlgorithm (
void
): array

Get the stream algorithm data.

getStringAlgorithm()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::getStringAlgorithm (
void
): array

Get the string algorithm data.

isAuth()

public \setasign\SetaPDF2\Core\SecHandler\AbstractHandler::isAuth (
void
): bool

Queries if the security handler is authenticated.

If not it tries by calling auth() without a password.

setCipherId()

public \setasign\SetaPDF2\Core\SecHandler\PublicKey::setCipherId (
int $cipherId
): void

Set the cipher id, that will be passed to openssl_pkcs7_encrypt().

ISO/DIS 32000-2: 7.6.5.3 Public-key encryption algorithms:

The algorithms that shall be used to encrypt the enveloped data in the PKCS#7 object are: RC4 with key lengths up to 256-bits, DES, Triple DES, RC2 with key lengths up to 128 bits, 128-bit AES in Cipher Block Chaining (CBC) mode, 192-bit AES in CBC mode, 256-bit AES in CBC mode.
Parameters
$cipherId : int
 
See

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)