Index

  1. \setasign\SetaPDF2
    1. Core
      1. SecHandler
        1. Standard
        2. Standard
          1. Aes128
          2. Aes256
          3. Aes256R5
          4. Arcfour128
          5. Arcfour128Cf
          6. Arcfour40

setasign\SetaPDF2\Core\SecHandler\Standard

Aes256 Generator class for AES 256 bit security handler (revision 6)

File: /SetaPDF v2/Core/SecHandler/Standard/Aes256.php
Old class name (alias): \SetaPDF_Core_SecHandler_Standard_Aes256

Class hierarchy

Implements

Summary

Static Methods

Static Properties

Methods

Properties

Static Properties

$_padding

static protected string \setasign\SetaPDF2\Core\SecHandler\Standard::$_padding =

The padding string


Properties

$_auth

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

Defines if this security handler is authenticated

$_authMode

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

The auth mode

Says who is authenticated: user or owner

$_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 Aes256::create (
\SetaPDF_Core_Document $document,
string $ownerPassword,
string $userPassword = '',
int $permissions = 0,
bool $encryptMetadata = true,
string $passwordsEncoding = 'utf-8'
): \SetaPDF_Core_SecHandler_Standard_Aes256

Create method for AES 256 bit security handler.

Parameters
$document : \SetaPDF_Core_Document
 
$ownerPassword : string

The owner password in UTF-8 encoding

$userPassword : string

The user password in UTF-8 encoding

$permissions : int
 
$encryptMetadata : bool
 
$passwordsEncoding : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

ensurePasswordEncoding()

public static \setasign\SetaPDF2\Core\SecHandler\Standard::ensurePasswordEncoding (
int $revision,
string $password,
string $encoding
): string

This method ensures the correct encoding of a password.

Internally the password is converted into the required encoding for the desired revision and it is pocessed with the SASLprep profile if requried.

Parameters
$revision : int
 
$password : string
 
$encoding : string
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

ensurePermissions()

public static \setasign\SetaPDF2\Core\SecHandler\Standard::ensurePermissions (
int $permissions,
int $revision
): int

Ensures bits in the permission flag.

Parameters
$permissions : int
 
$revision : int
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

factory()

WARNING: This method is marked as deprecated!

Use self::create() instead

public static Aes256::factory (
\SetaPDF_Core_Document $document,
string $ownerPassword,
string $userPassword = '',
int $permissions = 0,
bool $encryptMetadata = true,
string $passwordsEncoding = 'utf-8'
): \SetaPDF_Core_SecHandler_Standard_Aes256
Parameters
$document : \SetaPDF_Core_Document
 
$ownerPassword : string

The owner password in UTF-8 encoding

$userPassword : string

The user password in UTF-8 encoding

$permissions : int
 
$encryptMetadata : bool
 
$passwordsEncoding : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\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

_authByOwnerPassword()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_authByOwnerPassword (
string $ownerPassword = ''
): string|bool

Internal method to authenticate with the owner password.

Parameters
$ownerPassword : string
 
Return Values

The encryption key if the authentication was successful. False if not.

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_authByUserPassword()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_authByUserPassword (
string $userPassword = ''
): string|bool

Internal method to authenticate with the user password.

Parameters
$userPassword : string
 
Return Values

The encryption key if the authentication was successful. False if not.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_computeEncryptionKey()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_computeEncryptionKey (
string $password = ''
): string

Compute the encryption key based on a password.

Parameters
$password : string
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_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
 

_computeOValue()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_computeOValue (
string $userPassword,
string $ownerPassword = ''
): string

Compute the O value.

Parameters
$userPassword : string
 
$ownerPassword : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_computeUValue()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_computeUValue (
string $encryptionKey
): string

Compute the U value.

Parameters
$encryptionKey : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_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

_getEncryptionKeyByUserPassword()

protected \setasign\SetaPDF2\Core\SecHandler\Standard::_getEncryptionKeyByUserPassword (
string $password = ''
): string

Get the encryption key by the user password.

Parameters
$password : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\NotImplementedException

auth()

public \setasign\SetaPDF2\Core\SecHandler\Standard::auth (
string $password = null,
?string $encoding = null
): bool

Authenticate against the security handler.

This method will try to auth first with the owner password.

If this fails it will try to auth to the user password.

Parameters
$password : string
 
$encoding : ?string
 
Return Values

Authentication was successful or not

Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

authByOwnerPassword()

public \setasign\SetaPDF2\Core\SecHandler\Standard::authByOwnerPassword (
string $password,
?string $encoding = null
): bool

Authenticate with the owner password.

Parameters
$password : string
 
$encoding : ?string
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

authByUserPassword()

public \setasign\SetaPDF2\Core\SecHandler\Standard::authByUserPassword (
string $password,
null $encoding = null
): bool

Authenticate with the user password.

Parameters
$password : string
 
$encoding : null
 
Exceptions

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\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.

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\Standard::getPermission (
int $permission
): bool

Queries if a permission is granted.

Parameters
$permission : int
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPermissions()

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

Returns current permissions.

See

getRevision()

public \setasign\SetaPDF2\Core\SecHandler\Standard::getRevision (
void
): int

Get the revision of the security handler.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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.


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