PHP Класс Swift_Signers_DomainKeySigner

Автор: Xavier De Cock ([email protected])
Наследование: implements Swift_Signers_HeaderSigner
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$canon string Canonisation method.
$debugHeaders boolean Must we embed signed headers?
$domainKeyHeader Swift_Mime_Headers_ParameterizedHeader Stores the signature header.
$domainName string DomainName.
$hashAlgorithm string Hash algorithm used.
$ignoredHeaders array Headers not being signed.
$privateKey string PrivateKey.
$selector string Selector.
$signerIdentity string Signer identity.

Открытые методы

Метод Описание
__construct ( string $privateKey, string $domainName, string $selector ) Constructor.
addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner Add the signature to the given Headers.
bind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner Attach $is to this stream.
commit ( ) : Swift_Signers_DomainKeySigner For any bytes that are currently buffered inside the stream, force them off the buffer.
endBody ( ) End Body.
flushBuffers ( ) : Swift_Signers_DomainKeySigner Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
getAlteredHeaders ( ) : array Returns the list of Headers Tampered by this plugin.
ignoreHeader ( string $header_name ) : Swift_Signers_DomainKeySigner Adds an ignored Header.
reset ( ) : Swift_Signers_DomainKeySigner Resets internal states.
setCanon ( string $canon ) : Swift_Signers_DomainKeySigner Set the canonicalization algorithm.
setDebugHeaders ( boolean $debug ) : Swift_Signers_DomainKeySigner Enable / disable the DebugHeaders.
setHashAlgorithm ( string $hash ) : Swift_Signers_DomainKeySigner Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner Set the headers to sign.
setSignerIdentity ( string $identity ) : Swift_Signers_DomainKeySigner Set the signer identity.
startBody ( ) Start Body.
unbind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner Remove an already bound stream.
write ( string $bytes ) : Swift_Signers_DomainKeySigner Writes $bytes to the end of the stream.

Защищенные методы

Метод Описание
addHeader ( $header ) * Private helpers
canonicalizeBody ( $string )
endOfBody ( )
endOfHeaders ( )

Приватные методы

Метод Описание
addToHash ( $string )
getEncryptedHash ( ) : string
startHash ( )

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( string $privateKey, string $domainName, string $selector )
$privateKey string
$domainName string
$selector string

addHeader() защищенный Метод

* Private helpers
protected addHeader ( $header )

addSignature() публичный Метод

Add the signature to the given Headers.
public addSignature ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner
$headers Swift_Mime_HeaderSet
Результат Swift_Signers_DomainKeySigner

bind() публичный Метод

The stream acts as an observer, receiving all data that is written. All {@link write()} and {@link flushBuffers()} operations will be mirrored.
public bind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner
$is Swift_InputByteStream
Результат Swift_Signers_DomainKeySigner

canonicalizeBody() защищенный Метод

protected canonicalizeBody ( $string )

commit() публичный Метод

For any bytes that are currently buffered inside the stream, force them off the buffer.
public commit ( ) : Swift_Signers_DomainKeySigner
Результат Swift_Signers_DomainKeySigner

endBody() публичный Метод

End Body.
public endBody ( )

endOfBody() защищенный Метод

protected endOfBody ( )

endOfHeaders() защищенный Метод

protected endOfHeaders ( )

flushBuffers() публичный Метод

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
public flushBuffers ( ) : Swift_Signers_DomainKeySigner
Результат Swift_Signers_DomainKeySigner

getAlteredHeaders() публичный Метод

Returns the list of Headers Tampered by this plugin.
public getAlteredHeaders ( ) : array
Результат array

ignoreHeader() публичный Метод

Adds an ignored Header.
public ignoreHeader ( string $header_name ) : Swift_Signers_DomainKeySigner
$header_name string
Результат Swift_Signers_DomainKeySigner

reset() публичный Метод

Resets internal states.
public reset ( ) : Swift_Signers_DomainKeySigner
Результат Swift_Signers_DomainKeySigner

setCanon() публичный Метод

Set the canonicalization algorithm.
public setCanon ( string $canon ) : Swift_Signers_DomainKeySigner
$canon string simple | nofws defaults to simple
Результат Swift_Signers_DomainKeySigner

setDebugHeaders() публичный Метод

Enable / disable the DebugHeaders.
public setDebugHeaders ( boolean $debug ) : Swift_Signers_DomainKeySigner
$debug boolean
Результат Swift_Signers_DomainKeySigner

setHashAlgorithm() публичный Метод

Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.
public setHashAlgorithm ( string $hash ) : Swift_Signers_DomainKeySigner
$hash string
Результат Swift_Signers_DomainKeySigner

setHeaders() публичный Метод

Set the headers to sign.
public setHeaders ( Swift_Mime_HeaderSet $headers ) : Swift_Signers_DomainKeySigner
$headers Swift_Mime_HeaderSet
Результат Swift_Signers_DomainKeySigner

setSignerIdentity() публичный Метод

Set the signer identity.
public setSignerIdentity ( string $identity ) : Swift_Signers_DomainKeySigner
$identity string
Результат Swift_Signers_DomainKeySigner

startBody() публичный Метод

Start Body.
public startBody ( )

unbind() публичный Метод

If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs.
public unbind ( Swift_InputByteStream $is ) : Swift_Signers_DomainKeySigner
$is Swift_InputByteStream
Результат Swift_Signers_DomainKeySigner

write() публичный Метод

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call {@link commit()} after calling write(). This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).
public write ( string $bytes ) : Swift_Signers_DomainKeySigner
$bytes string
Результат Swift_Signers_DomainKeySigner

Описание свойств

$canon защищенное свойство

Canonisation method.
protected string $canon
Результат string

$debugHeaders защищенное свойство

Must we embed signed headers?
protected bool $debugHeaders
Результат boolean

$domainKeyHeader защищенное свойство

Stores the signature header.
protected Swift_Mime_Headers_ParameterizedHeader $domainKeyHeader
Результат Swift_Mime_Headers_ParameterizedHeader

$domainName защищенное свойство

DomainName.
protected string $domainName
Результат string

$hashAlgorithm защищенное свойство

Hash algorithm used.
protected string $hashAlgorithm
Результат string

$ignoredHeaders защищенное свойство

Headers not being signed.
protected array $ignoredHeaders
Результат array

$privateKey защищенное свойство

PrivateKey.
protected string $privateKey
Результат string

$selector защищенное свойство

Selector.
protected string $selector
Результат string

$signerIdentity защищенное свойство

Signer identity.
protected string $signerIdentity
Результат string