\Swift_Signers_DomainKeySigner
DomainKey Signer used to apply DomainKeys Signature to a message
- Author: Xavier De Cock <xdecock@gmail.com>
Synopsis
class Swift_Signers_DomainKeySigner
implements
Swift_Signers_HeaderSigner
{
- // members
- protected string $_privateKey;
- protected string $_domainName;
- protected string $_selector;
- protected string $_hashAlgorithm;
- protected string $_canon;
- protected array $_ignoredHeaders;
- protected unknown_type $_signerIdentity;
- protected boolean $_debugHeaders;
- private array $_signedHeaders;
- private string $_debugHeadersData;
- protected Swift_Mime_Headers_ParameterizedHeader $_domainKeyHeader;
- private hash_ressource $_hashHandler;
- private $_hash;
- private string $_canonData;
- private integer $_bodyCanonEmptyCounter;
- private integer $_bodyCanonIgnoreStart;
- private $_bodyCanonSpace;
- private $_bodyCanonLastChar;
- private string $_bodyCanonLine;
- private array $_bound;
- // methods
- public void __construct()
- public Swift_Signers_DomainKeysSigner reset()
- public Swift_Signers_DomainKeysSigner write()
- public Swift_Signers_DomainKeysSigner commit()
- public Swift_Signers_DomainKeysSigner bind()
- public Swift_Signers_DomainKeysSigner unbind()
- public Swift_Signers_DomainKeysSigner flushBuffers()
- public Swift_Signers_DomainKeysSigner setHashAlgorithm()
- public Swift_Signers_DomainKeysSigner setCanon()
- public Swift_Signers_DomainKeySigner setSignerIdentity()
- public Swift_Signers_DomainKeySigner setDebugHeaders()
- public void startBody()
- public void endBody()
- public array getAlteredHeaders()
- public Swift_Signers_DomainKeySigner ignoreHeader()
- public Swift_Signers_DomainKeySigner setHeaders()
- public Swift_Signers_DomainKeySigner addSignature()
- protected void _addHeader()
- protected void _endOfHeaders()
- protected void _canonicalizeBody()
- protected void _endOfBody()
- private void _addToHash()
- private void _startHash()
- private void _getEncryptedHash()
Hierarchy
Implements
Members
private
- $_bodyCanonEmptyCounter
- $_bodyCanonIgnoreStart
- $_bodyCanonLastChar
- $_bodyCanonLine
- $_bodyCanonSpace
- $_bound
- $_canonData
- $_debugHeadersData
—
string
If debugHeaders is set store debugDatas here - $_hash
- $_hashHandler
—
hash_ressource
Hash Handler - $_signedHeaders
—
array
Headers used to generate hash
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
—
unknown_type
Signer identity
Methods
private
protected
public
- __construct() — Constructor
- addSignature() — Add the signature to the given Headers
- bind() — Attach $is to this stream.
- commit() — For any bytes that are currently buffered inside the stream, force them off the buffer.
- endBody() — End Body
- flushBuffers() — Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
- getAlteredHeaders() — Returns the list of Headers Tampered by this plugin
- ignoreHeader() — Adds an ignored Header
- reset() — Resets internal states
- setCanon() — Set the canonicalization algorithm
- setDebugHeaders() — Enable / disable the DebugHeaders
- setHashAlgorithm() — Set hash_algorithm, must be one of rsa-sha256 | rsa-sha1 defaults to rsa-sha256
- setHeaders() — Set the headers to sign
- setSignerIdentity() — Set the signer identity
- startBody() — Start Body
- unbind() — Remove an already bound stream.
- write() — Writes $bytes to the end of the stream.