Home       Trees       Indices       Help   
Package dkim :: Class DomainSigner
[hide private]
[frames] | no frames]

Class DomainSigner

source code

object --+
         |
        DomainSigner
Known Subclasses:
Instance Methods [hide private]
 
__init__(self, message=None, logger=None, signature_algorithm='rsa-sha256', minkey=1024, linesep='\r\n', debug_content=False, timeout=5, tlsrpt=False)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 source code
 
add_frozen(self, s)
Add headers not in should_not_sign to frozen_sign.		 source code
 
add_should_not(self, s)
Add headers not in should_not_sign to frozen_sign.		 source code
 
set_message(self, message) source code
 
default_sign_headers(self)
Return the default list of headers to sign: those in should_sign or frozen_sign, with those in frozen_sign signed an extra time to prevent additions.		 source code
 
all_sign_headers(self)
Return header list of all existing headers not in should_not_sign.		 source code
 
gen_header(self, fields, include_headers, canon_policy, header_name, pk, standardize=False) source code
 
verify_sig_process(self, sig, include_headers, sig_header, dnsfunc)
Non-async sensitive verify_sig elements.		 source code
 
verify_sig(self, sig, include_headers, sig_header, dnsfunc) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  FROZEN = ('from')
  SHOULD = ('from', 'sender', 'reply-to', 'subject', 'date', 'me...
  SHOULD_NOT = ('return-path', 'received', 'comments', 'keywords...
  RFC5322_SINGLETON = ('date', 'from', 'sender', 'reply-to', 'to...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, message=None, logger=None, signature_algorithm='rsa-sha256', minkey=1024, linesep='\r\n', debug_content=False, timeout=5, tlsrpt=False)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

add_frozen(self, s)

source code 

Add headers not in should_not_sign to frozen_sign.

Parameters:
  • s - list of headers to add to frozen_sign

Since: 0.5 

>>> dkim = DKIM()
>>> dkim.add_frozen(DKIM.RFC5322_SINGLETON)
>>> [text(x) for x in sorted(dkim.frozen_sign)]
['cc', 'date', 'from', 'in-reply-to', 'message-id', 'references', 'reply-to', 'sender', 'to']
>>> dkim2 = DKIM()
>>> dkim2.add_frozen((b'date',b'subject'))
>>> [text(x) for x in sorted(dkim2.frozen_sign)]
['date', 'from', 'subject']

add_should_not(self, s)

source code 

Add headers not in should_not_sign to frozen_sign.

Parameters:
  • s - list of headers to add to frozen_sign

Since: 0.9 

>>> dkim = DKIM()
>>> dkim.add_should_not(DKIM.RFC5322_SINGLETON)
>>> [text(x) for x in sorted(dkim.should_not_sign)]
['bcc', 'cc', 'comments', 'date', 'dkim-signature', 'in-reply-to', 'keywords', 'message-id', 'received', 'references', 'reply-to', 'resent-bcc', 'return-path', 'sender', 'to']

default_sign_headers(self)

source code 

Return the default list of headers to sign: those in should_sign or frozen_sign, with those in frozen_sign signed an extra time to prevent additions.

Since: 0.5

all_sign_headers(self)

source code 

Return header list of all existing headers not in should_not_sign.

Since: 0.5

verify_sig_process(self, sig, include_headers, sig_header, dnsfunc)

source code 

Non-async sensitive verify_sig elements. Separated to avoid async code duplication.


Class Variable Details [hide private]

SHOULD

Value:
('from',
 'sender',
 'reply-to',
 'subject',
 'date',
 'message-id',
 'to',
 'cc',
...

SHOULD_NOT

Value:
('return-path',
 'received',
 'comments',
 'keywords',
 'bcc',
 'resent-bcc',
 'dkim-signature')

RFC5322_SINGLETON

Value:
('date',
 'from',
 'sender',
 'reply-to',
 'to',
 'cc',
 'bcc',
 'message-id',
...

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Mon Dec 16 12:46:42 2019 http://epydoc.sourceforge.net