Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Signers_DomainKeySigner

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Signers/DomainKeySigner.php

Class Overview


DomainKey Signer used to apply DomainKeys Signature to a message.


Author(s):

Implements interfaces:

Variables

Methods



Class Details

[line 16]
DomainKey Signer used to apply DomainKeys Signature to a message.



Tags:

author:  Xavier De Cock <xdecock@gmail.com>


[ Top ]


Class Variables

$_canon =  'simple'

[line 51]

Canonisation method.



Tags:

access:  protected

Type:   string


[ Top ]

$_debugHeaders =  false

[line 72]

Must we embed signed headers?



Tags:

access:  protected

Type:   bool


[ Top ]

$_domainKeyHeader =

[line 87]

Stores the signature header.



Tags:

access:  protected



[ Top ]

$_domainName =

[line 30]

DomainName.



Tags:

access:  protected

Type:   string


[ Top ]

$_hashAlgorithm =  'rsa-sha1'

[line 44]

Hash algorithm used.



Tags:

access:  protected

Type:   string


[ Top ]

$_ignoredHeaders = array()

[line 58]

Headers not being signed.



Tags:

access:  protected

Type:   array


[ Top ]

$_privateKey =

[line 23]

PrivateKey.



Tags:

access:  protected

Type:   string


[ Top ]

$_selector =

[line 37]

Selector.



Tags:

access:  protected

Type:   string


[ Top ]

$_signerIdentity =

[line 65]

Signer identity.



Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


static method newInstance [line 136]

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

Instanciate DomainKeySigner.



Tags:

access:  public


Parameters:

string   $privateKey  
string   $domainName  
string   $selector  

[ Top ]

constructor __construct [line 119]

Swift_Signers_DomainKeySigner __construct( string $privateKey, string $domainName, string $selector)

Constructor.



Tags:

access:  public


Parameters:

string   $privateKey  
string   $domainName  
string   $selector  

[ Top ]

method addSignature [line 397]

Swift_Signers_DomainKeySigner addSignature( Swift_Mime_HeaderSet $headers)

Add the signature to the given Headers.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::addSignature()
Add the header(s) to the headerSet.

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method bind [line 208]

Swift_Signers_DomainKeySigner 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.




Tags:

access:  public


Parameters:

Swift_InputByteStream   $is  

[ Top ]

method commit [line 193]

Swift_Signers_DomainKeySigner commit( )

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



Tags:

throws:  Swift_IoException
access:  public


[ Top ]

method endBody [line 325]

void endBody( )

End Body.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::endBody()
Give the signal that the body has finished streaming.
[ Top ]

method flushBuffers [line 248]

Swift_Signers_DomainKeySigner flushBuffers( )

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



Tags:

throws:  Swift_IoException
access:  public


[ Top ]

method getAlteredHeaders [line 335]

array getAlteredHeaders( )

Returns the list of Headers Tampered by this plugin.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::getAlteredHeaders()
Return the list of header a signer might tamper.
[ Top ]

method ignoreHeader [line 351]

Swift_Signers_DomainKeySigner ignoreHeader( string $header_name)

Adds an ignored Header.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::ignoreHeader()
Exclude an header from the signed headers.

Parameters:

string   $header_name  

[ Top ]

method reset [line 146]

Swift_Signers_DomainKeySigner reset( )

Resets internal states.



Tags:

access:  public



Implementation of:
Swift_Signer::reset()
[ Top ]

method setCanon [line 276]

Swift_Signers_DomainKeySigner setCanon( string $canon)

Set the canonicalization algorithm.



Tags:

access:  public


Parameters:

string   $canon   simple | nofws defaults to simple

[ Top ]

method setDebugHeaders [line 308]

Swift_Signers_DomainKeySigner setDebugHeaders( bool $debug)

Enable / disable the DebugHeaders.



Tags:

access:  public


Parameters:

bool   $debug  

[ Top ]

method setHashAlgorithm [line 262]

Swift_Signers_DomainKeySigner setHashAlgorithm( string $hash)

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



Tags:

access:  public


Parameters:

string   $hash  

[ Top ]

method setHeaders [line 365]

Swift_Signers_DomainKeySigner setHeaders( Swift_Mime_HeaderSet $headers)

Set the headers to sign.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::setHeaders()
Give the headers already given.

Parameters:

Swift_Mime_HeaderSet   $headers  

[ Top ]

method setSignerIdentity [line 294]

Swift_Signers_DomainKeySigner setSignerIdentity( string $identity)

Set the signer identity.



Tags:

access:  public


Parameters:

string   $identity  

[ Top ]

method startBody [line 318]

void startBody( )

Start Body.



Tags:

access:  public



Implementation of:
Swift_Signers_HeaderSigner::startBody()
Prepare the Signer to get a new Body.
[ Top ]

method unbind [line 226]

Swift_Signers_DomainKeySigner 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.




Tags:

access:  public


Parameters:

Swift_InputByteStream   $is  

[ Top ]

method write [line 175]

int write( string $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).




Tags:

throws:  Swift_IoException
access:  public


Parameters:

string   $bytes  

[ Top ]

method _addHeader [line 413]

void _addHeader( $header)



Tags:

access:  protected


Parameters:

   $header  

[ Top ]

method _canonicalizeBody [line 434]

void _canonicalizeBody( $string)



Tags:

access:  protected


Parameters:

   $string  

[ Top ]

method _endOfBody [line 483]

void _endOfBody( )



Tags:

access:  protected


[ Top ]

method _endOfHeaders [line 429]

void _endOfHeaders( )



Tags:

access:  protected


[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:47:46 +0000 by phpDocumentor 1.4.3