-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expose mechanisms in the high-level API
This creates a new class, Mechanism, for inquiring information about a mechanism. This includes support for RFCs 5587 and 5801. As Mechanism derives from OID, it is compatible with all places that accept a mech by OID. Signed-off-by: Alexander Scheel <ascheel@redhat.com>
- Loading branch information
Showing
4 changed files
with
250 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
from gssapi.raw import oids as roids | ||
from gssapi._utils import import_gssapi_extension | ||
from gssapi.raw import misc as rmisc | ||
|
||
rfc5587 = import_gssapi_extension('rfc5587') | ||
rfc5801 = import_gssapi_extension('rfc5801') | ||
|
||
|
||
class Mechanism(roids.OID): | ||
""" | ||
A GSSAPI Mechanism | ||
This class represents a mechanism and centralizes functions dealing with | ||
mechanisms and can be used with any calls. | ||
It inherits from the low-level GSSAPI :class:`~gssapi.raw.oids.OID` class, | ||
and thus can be used with both low-level and high-level API calls. | ||
""" | ||
_sasl_name = None | ||
_mech_attrs = None | ||
|
||
def __new__(cls, cpy=None, elements=None): | ||
return super(Mechanism, cls).__new__(cls, cpy, elements) | ||
|
||
@property | ||
def names(self): | ||
""" | ||
Get the set of name types supported by the mechanism. | ||
""" | ||
return rmisc.inquire_names_for_mech(self) | ||
|
||
@property | ||
def _query_saslname(self): | ||
if rfc5801 is None: | ||
raise NotImplementedError("Your GSSAPI implementation does not " | ||
"have support for RFC 5801") | ||
return rfc5801.inquire_saslname_for_mech(self) | ||
|
||
@property | ||
def _query_attrs(self): | ||
if rfc5587 is None: | ||
raise NotImplementedError("Your GSSAPI implementation does not " | ||
"have support for RFC 5587") | ||
|
||
return rfc5587.inquire_attrs_for_mech(self) | ||
|
||
def __repr__(self): | ||
""" | ||
Get a name representing the mechanism; always safe to call | ||
""" | ||
base = super(Mechanism, self).__repr__() | ||
if rfc5801 is not None: | ||
base = "%s %s" % (self._query_saslname.mech_name.decode('UTF-8'), | ||
base) | ||
|
||
return base | ||
|
||
@property | ||
def sasl_name(self): | ||
""" | ||
Get the SASL name for the mechanism; depends on RFC 5801 | ||
:requires-ext:`rfc5801` | ||
""" | ||
return self._query_saslname.sasl_mech_name.decode('UTF-8') | ||
|
||
@property | ||
def name(self): | ||
""" | ||
Get the name for the mechanism; depends on RFC 5801 | ||
:requires-ext:`rfc5801` | ||
""" | ||
self._query_saslname() | ||
return self._query_saslname.mech_name.decode('UTF-8') | ||
|
||
@property | ||
def description(self): | ||
""" | ||
Get the description of the mechanism; depends on RFC 5801 | ||
:requires-ext:`rfc5801` | ||
""" | ||
self._query_saslname() | ||
return self._query_saslname.mech_description.decode('UTF-8') | ||
|
||
@property | ||
def known_attrs(self): | ||
""" | ||
Get the known attributes of the mechanism; depends on RFC 5587 | ||
:requires-ext:`rfc5587` | ||
""" | ||
return self._query_attrs.known_mech_attrs | ||
|
||
@property | ||
def attrs(self): | ||
""" | ||
Get the attributes of the mechanism; depends on RFC 5587 | ||
:requires-ext:`rfc5587` | ||
""" | ||
return self._query_attrs.mech_attrs | ||
|
||
@classmethod | ||
def all_mechs(cls): | ||
""" | ||
all_mechs() | ||
Get a list of all mechanisms supported by GSSAPI | ||
""" | ||
mechs = rmisc.indicate_mechs() | ||
return [cls(mech) for mech in mechs] | ||
|
||
@classmethod | ||
def from_name(cls, name=None): | ||
""" | ||
from_name(name) | ||
Get a set of mechanisms that may be able to process the name | ||
Args: | ||
name (Name): a name to inquire about | ||
Returns: | ||
[Mechanism]: a set of mechanisms which support this name | ||
Raises: | ||
GSSError | ||
""" | ||
mechs = rmisc.inquire_mechs_for_name(name) | ||
return [cls(mech) for mech in mechs] | ||
|
||
@classmethod | ||
def from_sasl_name(cls, name=None): | ||
""" | ||
from_sasl_name(name) | ||
Create a Mechanism from its SASL name | ||
Args: | ||
name (str): SASL name of the desired mechanism | ||
Returns: | ||
Mechanism: the desired mechanism | ||
Raises: | ||
GSSError | ||
:requires-ext:`rfc5801` | ||
""" | ||
if rfc5801 is None: | ||
raise NotImplementedError("Your GSSAPI implementation does not " | ||
"have support for RFC 5801") | ||
n = name | ||
if type(n) is not bytes: | ||
n = str(n).encode() | ||
|
||
m = rfc5801.inquire_mech_for_saslname(n) | ||
|
||
return cls(m) | ||
|
||
@classmethod | ||
def from_attrs(cls, m_desired=None, m_except=None, m_critical=None): | ||
""" | ||
from_attrs | ||
Get the set of mechanisms supporting the specified attributes. See | ||
RFC 5587's indicate_mechs_by_attrs for more information. | ||
Args: | ||
m_desired ([OID]): Desired attributes | ||
m_except ([OID]): Except attributes | ||
m_critical ([OID]): Critical attributes | ||
Returns: | ||
[Mechanism]: A set of mechanisms having the desired features. | ||
Raises: | ||
GSSError | ||
:requires-ext:`rfc5587` | ||
""" | ||
if type(m_desired) == roids.OID: | ||
m_desired = set([m_desired]) | ||
if type(m_except) == roids.OID: | ||
m_except = set([m_except]) | ||
if type(m_critical) == roids.OID: | ||
m_critical = set([m_critical]) | ||
|
||
if rfc5587 is None: | ||
raise NotImplementedError("Your GSSAPI implementation does not " | ||
"have support for RFC 5587") | ||
|
||
mechs = rfc5587.indicate_mechs_by_attrs(m_desired, | ||
m_except, | ||
m_critical) | ||
return [cls(mech) for mech in mechs] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters