Package nss :: Module nss :: Class AuthKeyID
[hide private]
[frames] | no frames]

Class AuthKeyID

object --+
         |
        AuthKeyID

An object representing Authentication Key ID extension

Instance Methods [hide private]
 
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
a new object with type S, a subtype of T

__new__(T, S, ...)
 
__repr__(x)
repr(x)
 
__str__(x)
str(x)
string)

format(level=0, indent=' ')
:Parameters: level : integer Initial indentation level, all subsequent indents are relative to this starting level.
[(level, string),...]

format_lines(level=0)
:Parameters: level : integer Initial indentation level, all subsequent indents are relative to this starting level.
(general_name, ...)

get_general_names(repr_kind=AsString)
:Parameters: repr_kind : RepresentationKind constant Specifies what the contents of the returned tuple will be.

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

Properties [hide private]
  key_id
Returns the key id as a SecItem
  serial_number
Returns the key id as a SecItem

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

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

Overrides: object.__init__

__new__(T, S, ...)

 


Returns:
a new object with type S, a subtype of T

Overrides: object.__new__

__repr__(x)
(Representation operator)

 
repr(x)

Overrides: object.__repr__

__str__(x)
(Informal representation operator)

 
str(x)

Overrides: object.__str__

format(level=0, indent=' ')

 
:Parameters:
    level : integer
        Initial indentation level, all subsequent indents are relative
        to this starting level.
    indent : string
        string replicated once for each indent level then prepended to output line

This is equivalent to:
indented_format(obj.format_lines()) on an object providing a format_lines() method.

Returns:
string)

format_lines(level=0)

 
:Parameters:
    level : integer
        Initial indentation level, all subsequent indents are relative
        to this starting level.

Formats the object into a sequence of lines with indent level
information.  The return value is a list where each list item is a
tuple.  The first item in the tuple is an integer
representing the indentation level for that line. Any remaining items
in the tuple are strings to be output on that line.

The output of this function can be formatted into a single string by
calling `indented_format()`, e.g.:

    print indented_format(obj.format_lines())

The reason this function returns a tuple as opposed to an single
indented string is to support other text formatting systems such as
GUI's with indentation controls.  See `indented_format()` for a
complete explanation.

Returns:
[(level, string),...]

get_general_names(repr_kind=AsString)

 
:Parameters:
    repr_kind : RepresentationKind constant
        Specifies what the contents of the returned tuple will be.
        May be one of:

        AsObject
            The general name as a nss.GeneralName object
        AsString
            The general name as a string.
            (e.g. "http://crl.geotrust.com/crls/secureca.crl")
        AsTypeString
            The general name type as a string.
             (e.g. "URI")
        AsTypeEnum
            The general name type as a general name type enumerated constant.
             (e.g. nss.certURI )
        AsLabeledString
            The general name as a string with it's type prepended.
            (e.g. "URI: http://crl.geotrust.com/crls/secureca.crl"

Returns a tuple of general names in the authentication key id extension
for the issuer. If the issuer was not defined then the returned tuple
will be empty.

You may specify how the each member of the tuple is represented, by default
it will be as a string.

Returns:
(general_name, ...)