Index

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

SetaPDF_Core_SecHandler_PublicKey_Arcfour128Cf Generator class for RC4 128 bit public-key security handler with crypt filters

File: /SetaPDF v2/Core/SecHandler/PublicKey/Arcfour128Cf.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

PERM_OWNER

public const integer SetaPDF_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 boolean SetaPDF_Core_SecHandler_AbstractHandler::$_auth = false

Defines if this security handler is authenticated

$_authData

protected array SetaPDF_Core_SecHandler_PublicKey::$_authData = array(...)

An array holding authentication data.

$_authMode

protected string|null SetaPDF_Core_SecHandler_AbstractHandler::$_authMode

The auth mode

Says who is authenticated: user or owner

$_cipherId

protected int SetaPDF_Core_SecHandler_PublicKey::$_cipherId = 7

The cipher id that is passed to openssl_pkcs7_encrypt().

See

$_document

protected SetaPDF_Core_Document SetaPDF_Core_SecHandler_AbstractHandler::$_document

The document to which this security handler is attached

$_encryptMetadata

protected boolean SetaPDF_Core_SecHandler_AbstractHandler::$_encryptMetadata = true

Metadata are encrypted or not

$_encryptionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_SecHandler_AbstractHandler::$_encryptionDictionary

The encryption dictionary

$_encryptionKey

protected string SetaPDF_Core_SecHandler_AbstractHandler::$_encryptionKey

The encryption key

$_keyLength

protected integer SetaPDF_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 SetaPDF_Core_SecHandler_AbstractHandler::$_streamAlgorithm = array(...)

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

$_stringAlgorithm

protected array SetaPDF_Core_SecHandler_AbstractHandler::$_stringAlgorithm = array(...)

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


Static Methods

create()

public static SetaPDF_Core_SecHandler_PublicKey_Arcfour128Cf::create (): SetaPDF_Core_SecHandler_PublicKey_Arcfour128Cf

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

Parameters
$document : SetaPDF_Core_Document
 
$recipients : SetaPDF_Core_SecHandler_PublicKey_Recipient[]|SetaPDF_Core_SecHandler_PublicKey_Recipient
 
$encryptMetadata : boolean
 
Exceptions

Throws Exception

Throws SetaPDF_Core_SecHandler_Exception

factory()

WARNING: This method is marked as deprecated!

Use self::create() instead

public static SetaPDF_Core_SecHandler_PublicKey_Arcfour128Cf::factory (): SetaPDF_Core_SecHandler_PublicKey_Arcfour128Cf
Parameters
$document : SetaPDF_Core_Document
 
$recipients : SetaPDF_Core_SecHandler_PublicKey_Recipient[]|SetaPDF_Core_SecHandler_PublicKey_Recipient
 
$encryptMetadata : boolean
 
Exceptions

Throws Exception

Throws SetaPDF_Core_SecHandler_Exception


Methods

__construct()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_cleanUp()

protected SetaPDF_Core_SecHandler_PublicKey::_cleanUp (
void
): void

Removes temporary files.

_computeEncryptionKey()

protected SetaPDF_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 SetaPDF_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 SetaPDF_Core_SecHandler_AbstractHandler::_crypt (
string $data, array $algorithm [, SetaPDF_Core_Type_IndirectObject $param = null [, boolean $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 : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

_prepareEnvelopes()

protected SetaPDF_Core_SecHandler_PublicKey::_prepareEnvelopes (): string[]

Prepares the PKCS#7 envelopes.

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

Throws Exception

_preparePermission()

protected SetaPDF_Core_SecHandler_PublicKey::_preparePermission (
int $permissions
): string

Prepares permission flag.

Parameters
$permissions : int
 

auth()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

Throws Exception

decryptStream()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

decryptString()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

encryptStream()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

encryptString()

public SetaPDF_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 SetaPDF_Core_SecHandler_Exception

getAuthMode()

public SetaPDF_Core_SecHandler_AbstractHandler::getAuthMode (
void
): string

Get the auth method.

Return Values

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

getCipherId()

public SetaPDF_Core_SecHandler_PublicKey::getCipherId (
void
): int

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

See

getDocument()

public SetaPDF_Core_SecHandler_AbstractHandler::getDocument (
void
): SetaPDF_Core_Document

Returns the document instance of this security handler.

getEncryptMetadata()

public SetaPDF_Core_SecHandler_AbstractHandler::getEncryptMetadata (
void
): boolean

Returns true if the metadata are/will be encrypted.

getEncryptionDictionary()

public SetaPDF_Core_SecHandler_AbstractHandler::getEncryptionDictionary (
void
): SetaPDF_Core_Type_Dictionary

Gets the encryption dictionary.

getEncryptionKey()

public SetaPDF_Core_SecHandler_AbstractHandler::getEncryptionKey (
void
): string

Get the encryption key if known/authenticated.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

getPdfVersion()

public SetaPDF_Core_SecHandler_AbstractHandler::getPdfVersion (
void
): string

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

Exceptions

Throws SetaPDF_Exception_NotImplemented

getPermission()

public SetaPDF_Core_SecHandler_AbstractHandler::getPermission (
integer $permission
): boolean

Queries if a permission is granted.

Parameters
$permission : integer
 

getPermissions()

public SetaPDF_Core_SecHandler_PublicKey::getPermissions (
void
): integer

Returns current permissions.

See

getStreamAlgorithm()

public SetaPDF_Core_SecHandler_AbstractHandler::getStreamAlgorithm (
void
): array

Get the stream algorithm data.

getStringAlgorithm()

public SetaPDF_Core_SecHandler_AbstractHandler::getStringAlgorithm (
void
): array

Get the string algorithm data.

isAuth()

public SetaPDF_Core_SecHandler_AbstractHandler::isAuth (
void
): boolean

Queries if the security handler is authenticated.

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

setCipherId()

public SetaPDF_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

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