Swift_Signers_DomainKeySigner Class Reference

Inheritance diagram for Swift_Signers_DomainKeySigner:

Public Member Functions
	__construct ($privateKey, $domainName, $selector)
	reset ()
	write ($bytes)
	commit ()
	bind (Swift_InputByteStream $is)
	unbind (Swift_InputByteStream $is)
	flushBuffers ()
	setHashAlgorithm ($hash)
	setCanon ($canon)
	setSignerIdentity ($identity)
	setDebugHeaders ($debug)
	startBody ()
	endBody ()
	getAlteredHeaders ()
	ignoreHeader ($header_name)
	setHeaders (Swift_Mime_HeaderSet $headers)
	addSignature (Swift_Mime_HeaderSet $headers)

Static Public Member Functions
static	newInstance ($privateKey, $domainName, $selector)

Protected Member Functions
	_addHeader ($header)
	_endOfHeaders ()
	_canonicalizeBody ($string)
	_endOfBody ()

Protected Attributes
	$_privateKey
	$_domainName
	$_selector
	$_hashAlgorithm = 'rsa-sha1'
	$_canon = 'simple'
	$_ignoredHeaders = array()
	$_signerIdentity
	$_debugHeaders = false
	$_domainKeyHeader

Private Member Functions
	_addToHash ($string)
	_startHash ()
	_getEncryptedHash ()

Private Attributes
	$_signedHeaders = array()
	$_hashHandler
	$_hash
	$_canonData = ''
	$_bodyCanonEmptyCounter = 0
	$_bodyCanonIgnoreStart = 2
	$_bodyCanonSpace = false
	$_bodyCanonLastChar = null
	$_bodyCanonLine = ''
	$_bound = array()

Detailed Description

DomainKey Signer used to apply DomainKeys Signature to a message.

Author

Xavier De Cock xdeco.nosp@m.ck@g.nosp@m.mail..nosp@m.com

Definition at line 16 of file DomainKeySigner.php.

Constructor & Destructor Documentation

__construct	(		$privateKey,
			$domainName,
			$selector
	)

Constructor.

Parameters

string	$privateKey
string	$domainName
string	$selector

Definition at line 119 of file DomainKeySigner.php.

Member Function Documentation

_addHeader (   $header )

protected

Definition at line 413 of file DomainKeySigner.php.

References _addToHash().

Referenced by setHeaders().

_addToHash (   $string )

private

Definition at line 491 of file DomainKeySigner.php.

Referenced by _addHeader(), _canonicalizeBody(), and _endOfBody().

_canonicalizeBody (   $string )

protected

Definition at line 434 of file DomainKeySigner.php.

References $_bodyCanonEmptyCounter, $_bodyCanonIgnoreStart, and _addToHash().

Referenced by write().

_endOfBody ( )

protected

Definition at line 483 of file DomainKeySigner.php.

References _addToHash().

Referenced by endBody().

_endOfHeaders ( )

protected

Definition at line 429 of file DomainKeySigner.php.

Referenced by setHeaders().

_getEncryptedHash ( )

private

Exceptions

Swift_SwiftException

Returns

string

Definition at line 513 of file DomainKeySigner.php.

Referenced by addSignature().

_startHash ( )

private

Definition at line 497 of file DomainKeySigner.php.

Referenced by setHeaders().

addSignature

(

Swift_Mime_HeaderSet

$headers

)

Add the signature to the given Headers.

Parameters

Swift_Mime_HeaderSet

$headers

Returns

Swift_Signers_DomainKeySigner

Implements Swift_Signers_HeaderSigner.

Definition at line 397 of file DomainKeySigner.php.

References _getEncryptedHash(), and Swift_Mime_HeaderSet\addTextHeader().

bind

(

Swift_InputByteStream

$is

)

Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All write() and flushBuffers() operations will be mirrored.

Parameters

Swift_InputByteStream

$is

Returns

Swift_Signers_DomainKeysSigner

Implements Swift_InputByteStream.

Definition at line 208 of file DomainKeySigner.php.

commit

(

)

For any bytes that are currently buffered inside the stream, force them off the buffer.

Exceptions

Swift_IoException

Returns

Swift_Signers_DomainKeysSigner

Implements Swift_InputByteStream.

Definition at line 193 of file DomainKeySigner.php.

endBody

(

)

End Body.

Implements Swift_Signers_HeaderSigner.

Definition at line 325 of file DomainKeySigner.php.

References _endOfBody().

flushBuffers

(

)

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

Exceptions

Swift_IoException

Returns

Swift_Signers_DomainKeysSigner

Implements Swift_InputByteStream.

Definition at line 248 of file DomainKeySigner.php.

References reset().

getAlteredHeaders

(

)

Returns the list of Headers Tampered by this plugin.

Returns

array

Implements Swift_Signers_HeaderSigner.

Definition at line 335 of file DomainKeySigner.php.

ignoreHeader

(

$header_name

)

Adds an ignored Header.

Parameters

string

$header_name

Returns

Swift_Signers_DomainKeySigner

Implements Swift_Signers_HeaderSigner.

Definition at line 351 of file DomainKeySigner.php.

static newInstance (   $privateKey,   $domainName,   $selector  )

static

Instanciate DomainKeySigner.

Parameters

string	$privateKey
string	$domainName
string	$selector

Returns

Swift_Signers_DomainKeySigner

Definition at line 136 of file DomainKeySigner.php.

reset

(

)

Resets internal states.

Returns

Swift_Signers_DomainKeysSigner

Implements Swift_Signer.

Definition at line 146 of file DomainKeySigner.php.

Referenced by flushBuffers().

setCanon

(

$canon

)

Set the canonicalization algorithm.

Parameters

string

$canon

simple | nofws defaults to simple

Returns

Swift_Signers_DomainKeysSigner

Definition at line 276 of file DomainKeySigner.php.

setDebugHeaders

(

$debug

)

Enable / disable the DebugHeaders.

Parameters

bool

$debug

Returns

Swift_Signers_DomainKeySigner

Definition at line 308 of file DomainKeySigner.php.

setHashAlgorithm

(

$hash

)

Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256.

Parameters

string

$hash

Returns

Swift_Signers_DomainKeysSigner

Definition at line 262 of file DomainKeySigner.php.

setHeaders

(

Swift_Mime_HeaderSet

$headers

)

Set the headers to sign.

Parameters

Swift_Mime_HeaderSet

$headers

Returns

Swift_Signers_DomainKeySigner

Implements Swift_Signers_HeaderSigner.

Definition at line 365 of file DomainKeySigner.php.

References _addHeader(), _endOfHeaders(), _startHash(), Swift_Mime_HeaderSet\getAll(), Swift_Mime_HeaderSet\has(), and Swift_Mime_HeaderSet\listAll().

setSignerIdentity

(

$identity

)

Set the signer identity.

Parameters

string

$identity

Returns

Swift_Signers_DomainKeySigner

Definition at line 294 of file DomainKeySigner.php.

startBody

(

)

Start Body.

Implements Swift_Signers_HeaderSigner.

Definition at line 318 of file DomainKeySigner.php.

unbind

(

Swift_InputByteStream

$is

)

Remove an already bound stream. 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.

Parameters

Swift_InputByteStream

$is

Returns

Swift_Signers_DomainKeysSigner

Implements Swift_InputByteStream.

Definition at line 226 of file DomainKeySigner.php.

write

(

$bytes

)

Writes $bytes to the end of the stream.

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call commit() after calling write().

This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).

Parameters

string

$bytes

Exceptions

Swift_IoException

Returns

int

Swift_Signers_DomainKeysSigner

Implements Swift_InputByteStream.

Definition at line 175 of file DomainKeySigner.php.

References _canonicalizeBody().

Member Data Documentation

$_bodyCanonEmptyCounter = 0

private

Definition at line 100 of file DomainKeySigner.php.

Referenced by _canonicalizeBody().

$_bodyCanonIgnoreStart = 2

private

Definition at line 102 of file DomainKeySigner.php.

Referenced by _canonicalizeBody().

$_bodyCanonLastChar = null

private

Definition at line 106 of file DomainKeySigner.php.

$_bodyCanonLine = ''

private

Definition at line 108 of file DomainKeySigner.php.

$_bodyCanonSpace = false

private

Definition at line 104 of file DomainKeySigner.php.

$_bound = array()

private

Definition at line 110 of file DomainKeySigner.php.

$_canon = 'simple'

protected

Definition at line 51 of file DomainKeySigner.php.

$_canonData = ''

private

Definition at line 98 of file DomainKeySigner.php.

$_debugHeaders = false

protected

Definition at line 72 of file DomainKeySigner.php.

$_domainKeyHeader

protected

Definition at line 87 of file DomainKeySigner.php.

$_domainName

protected

Definition at line 30 of file DomainKeySigner.php.

$_hash

private

Definition at line 96 of file DomainKeySigner.php.

$_hashAlgorithm = 'rsa-sha1'

protected

Definition at line 44 of file DomainKeySigner.php.

$_hashHandler

private

Definition at line 94 of file DomainKeySigner.php.

$_ignoredHeaders = array()

protected

Definition at line 58 of file DomainKeySigner.php.

$_privateKey

protected

Definition at line 23 of file DomainKeySigner.php.

$_selector

protected

Definition at line 37 of file DomainKeySigner.php.

$_signedHeaders = array()

private

Definition at line 80 of file DomainKeySigner.php.

$_signerIdentity

protected

Definition at line 65 of file DomainKeySigner.php.