Back to index

moin  1.9.0~rc2
Public Member Functions | Public Attributes | Properties
MoinMoin.support.werkzeug.datastructures.Authorization Class Reference
Inheritance diagram for MoinMoin.support.werkzeug.datastructures.Authorization:
Inheritance graph
[legend]
Collaboration diagram for MoinMoin.support.werkzeug.datastructures.Authorization:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def qop
def setdefault
def update
def pop
def popitem
def __setitem__
def __delitem__
def clear

Public Attributes

 type

Properties

 username
 password
 realm
 nonce
 uri
 nc
 cnonce
 response
 opaque

Detailed Description

Represents an `Authorization` header sent by the client.  You should
not create this kind of object yourself but use it when it's returned by
the `parse_authorization_header` function.

This object is a dict subclass and can be altered by setting dict items
but it should be considered immutable as it's returned by the client and
not meant for modifications.

.. versionchanged:: 0.5
   This object became immutable.

Definition at line 1730 of file datastructures.py.


Constructor & Destructor Documentation

def MoinMoin.support.werkzeug.datastructures.Authorization.__init__ (   self,
  auth_type,
  data = None 
)

Definition at line 1743 of file datastructures.py.

01743 
01744     def __init__(self, auth_type, data=None):
01745         dict.__init__(self, data or {})
01746         self.type = auth_type


Member Function Documentation

Definition at line 102 of file datastructures.py.

00102 
00103     def __delitem__(self, key):
00104         is_immutable(self)

Here is the call graph for this function:

Here is the caller graph for this function:

def MoinMoin.support.werkzeug.datastructures.ImmutableDictMixin.__setitem__ (   self,
  key,
  value 
) [inherited]

Definition at line 99 of file datastructures.py.

00099 
00100     def __setitem__(self, key, value):
00101         is_immutable(self)

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 105 of file datastructures.py.

00105 
00106     def clear(self):
00107         is_immutable(self)
00108 

Here is the call graph for this function:

def MoinMoin.support.werkzeug.datastructures.ImmutableDictMixin.pop (   self,
  key,
  default = None 
) [inherited]

Definition at line 93 of file datastructures.py.

00093 
00094     def pop(self, key, default=None):
00095         is_immutable(self)

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 96 of file datastructures.py.

00096 
00097     def popitem(self):
00098         is_immutable(self)

Here is the call graph for this function:

Indicates what "quality of protection" the client has applied to
the message for HTTP digest auth.

Definition at line 1779 of file datastructures.py.

01779 
01780     def qop(self):
01781         """Indicates what "quality of protection" the client has applied to
01782         the message for HTTP digest auth."""
01783         def on_update(header_set):
01784             if not header_set and 'qop' in self:
01785                 del self['qop']
01786             elif header_set:
01787                 self['qop'] = header_set.to_header()
01788         return parse_set_header(self.get('qop'), on_update)
01789 

Here is the call graph for this function:

def MoinMoin.support.werkzeug.datastructures.ImmutableDictMixin.setdefault (   self,
  key,
  default = None 
) [inherited]

Definition at line 87 of file datastructures.py.

00087 
00088     def setdefault(self, key, default=None):
00089         is_immutable(self)

Here is the call graph for this function:

def MoinMoin.support.werkzeug.datastructures.ImmutableDictMixin.update (   self,
  args,
  kwargs 
) [inherited]

Definition at line 90 of file datastructures.py.

00090 
00091     def update(self, *args, **kwargs):
00092         is_immutable(self)

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Definition at line 1745 of file datastructures.py.


Property Documentation

Initial value:
property(lambda x: x.get('cnonce'), doc='''
    If the server sent a qop-header in the ``WWW-Authenticate``
    header, the client has to provide this value for HTTP digest auth.
    See the RFC for more details.''')

Definition at line 1766 of file datastructures.py.

Initial value:
property(lambda x: x.get('nc'), doc='''
    The nonce count value transmitted by clients if a qop-header is
    also transmitted.  HTTP digest auth only.''')

Definition at line 1763 of file datastructures.py.

Initial value:
property(lambda x: x.get('nonce'), doc='''
    The nonce the server sent for digest auth, sent back by the client.
    A nonce should be unique for every 401 response for HTTP digest
    auth.''')

Definition at line 1755 of file datastructures.py.

Initial value:
property(lambda x: x.get('opaque'), doc='''
    The opaque header from the server returned unchanged by the client.
    It is recommended that this string be base64 or hexadecimal data.
    Digest auth only.''')

Definition at line 1773 of file datastructures.py.

Initial value:
property(lambda x: x.get('password'), doc='''
    When the authentication type is basic this is the password
    transmitted by the client, else `None`.''')

Definition at line 1750 of file datastructures.py.

Initial value:
property(lambda x: x.get('realm'), doc='''
    This is the server realm sent back for HTTP digest auth.''')

Definition at line 1753 of file datastructures.py.

Initial value:
property(lambda x: x.get('response'), doc='''
    A string of 32 hex digits computed as defined in RFC 2617, which
    proves that the user knows a password.  Digest auth only.''')

Definition at line 1770 of file datastructures.py.

Initial value:
property(lambda x: x.get('uri'), doc='''
    The URI from Request-URI of the Request-Line; duplicated because
    proxies are allowed to change the Request-Line in transit.  HTTP
    digest auth only.''')

Definition at line 1759 of file datastructures.py.

Initial value:
property(lambda x: x.get('username'), doc='''
    The username transmitted.  This is set for both basic and digest
    auth all the time.''')

Definition at line 1747 of file datastructures.py.


The documentation for this class was generated from the following file: