pyspnego API reference

151 public APIs from pyspnego (jborean93/pyspnego) — 53 classes, 33 functions, 65 methods. Signatures extracted by static analysis of the actual source.

Repository: jborean93/pyspnego

Kind	Count
Classes	53
Functions	33
Methods	65

API list

funcsrc.spnego.__main__.main(args:typing.List[str]) -> None

Main program entry point.

funcsrc.spnego.__main__.parse_args(args:typing.List[str]) -> argparse.Namespace

Parse and return args.

funcsrc.spnego.__main__.parse_tls_token(b_data:bytes) -> typing.List[typing.Dict[str, typing.Any]]

:param b_data: A byte string of the TLS token to parse.

func

src.spnego._asn1.pack_asn1(tag_class:TagClass, constructed:bool, tag_number:typing.Union[TypeTagNumber, int], b_data:bytes) -> bytes

Pack the ASN.1 value into the ASN.1 bytes.

funcsrc.spnego._asn1.unpack_asn1(b_data:bytes) -> typing.Tuple[ASN1Value, bytes]

Unpacks an ASN.1 TLV into each element.

funcsrc.spnego._asn1.unpack_asn1_bit_string(value:typing.Union[ASN1Value, bytes]) -> bytes

Unpacks an ASN.1 BIT STRING value.

funcsrc.spnego._asn1.unpack_asn1_boolean(value:typing.Union[ASN1Value, bytes]) -> bool

Unpacks an ASN.1 BOOLEAN value.

funcsrc.spnego._asn1.unpack_asn1_enumerated(value:typing.Union[ASN1Value, bytes]) -> int

Unpacks an ASN.1 ENUMERATED value.

funcsrc.spnego._asn1.unpack_asn1_general_string(value:typing.Union[ASN1Value, bytes]) -> bytes

Unpacks an ASN.1 GeneralString value.

funcsrc.spnego._asn1.unpack_asn1_generalized_time(value:typing.Union[ASN1Value, bytes]) -> datetime.datetime

Unpacks an ASN.1 GeneralizedTime value.

funcsrc.spnego._asn1.unpack_asn1_integer(value:typing.Union[ASN1Value, bytes]) -> int

Unpacks an ASN.1 INTEGER value.

funcsrc.spnego._asn1.unpack_asn1_object_identifier(value:typing.Union[ASN1Value, bytes]) -> str

Unpacks an ASN.1 OBJECT IDENTIFIER value.

funcsrc.spnego._asn1.unpack_asn1_octet_string(value:typing.Union[ASN1Value, bytes]) -> bytes

Unpacks an ASN.1 OCTET STRING value.

funcsrc.spnego._asn1.unpack_asn1_sequence(value:typing.Union[ASN1Value, bytes]) -> typing.List[ASN1Value]

Unpacks an ASN.1 SEQUENCE value.

funcsrc.spnego._asn1.unpack_asn1_tagged_sequence(value:typing.Union[ASN1Value, bytes]) -> typing.Dict[int, ASN1Value]

Unpacks an ASN.1 SEQUENCE value as a dictionary.

classsrc.spnego._context.ContextProxy

Base class for a authentication context.

methodsrc.spnego._context.ContextProxy.available_protocols(options:typing.Optional[NegotiateOptions]=None) -> typing.List[str]

A list of protocols that the provider can offer.

methodsrc.spnego._context.ContextProxy.context_attr() -> ContextReq

The context attributes that were negotiated.

methodsrc.spnego._context.ContextProxy.get_extra_info(name:str, default:typing.Any=None) -> typing.Any

Return information about the security context.

methodsrc.spnego._context.ContextProxy.negotiated_protocol() -> typing.Optional[str]

The name of the negotiated protocol.

methodsrc.spnego._context.ContextProxy.new_context() -> 'ContextProxy'

Creates a new security context.

methodsrc.spnego._context.ContextProxy.session_key() -> bytes

The derived session key.

methodsrc.spnego._context.ContextProxy.sign(data:bytes, qop:typing.Optional[int]=None) -> bytes

Generates a signature/MIC for a message.

method

src.spnego._context.ContextProxy.step(in_token:typing.Optional[bytes]=None, *channel_bindings:typing.Optional[GssChannelBindings]=None) -> typing.Optional[bytes]

Performs a negotiation step.

methodsrc.spnego._context.ContextProxy.unwrap(data:bytes) -> UnwrapResult

Unwrap a message.

methodsrc.spnego._context.ContextProxy.unwrap_iov(iov:typing.Iterable[IOV]) -> IOVUnwrapResult

Unwrap/Decrypt an IOV buffer.

methodsrc.spnego._context.ContextProxy.unwrap_winrm(header:bytes, data:bytes) -> bytes

Unwrap/Decrypt a WinRM message.

methodsrc.spnego._context.ContextProxy.verify(data:bytes, mic:bytes) -> int

Verify the signature/MIC for a message.

methodsrc.spnego._context.ContextProxy.wrap(data:bytes, encrypt:bool=True, qop:typing.Optional[int]=None) -> WrapResult

Wrap a message, optionally with encryption.

method

src.spnego._context.ContextProxy.wrap_iov(iov:typing.Iterable[IOV], encrypt:bool=True, qop:typing.Optional[int]=None) -> IOVWrapResult

Wrap/Encrypt an IOV buffer.

methodsrc.spnego._context.ContextProxy.wrap_winrm(data:bytes) -> WinRMWrapResult

Wrap/Encrypt data for use with WinRM.

classsrc.spnego._context.IOVUnwrapResult

Result of the `unwrap_iov()` function.

classsrc.spnego._context.IOVWrapResult

Result of the `wrap_iov()` function.

classsrc.spnego._context.SecPkgContextSizes

Sizes of important structures used for messages.

classsrc.spnego._context.UnwrapResult

Result of the `unwrap()` function.

classsrc.spnego._context.WinRMWrapResult

Result of the `wrap_winrm()` function.

classsrc.spnego._context.WrapResult

Result of the `wrap()` function.

classsrc.spnego._credential.CredentialCache

Cached credential.

classsrc.spnego._credential.KerberosCCache

Kerberos CCache Credential.

classsrc.spnego._credential.KerberosKeytab

Kerberos Keytab Credential.

classsrc.spnego._credential.NTLMHash

NTLM LM/NT Hash credential.

methodsrc.spnego._credential.NTLMHash.supported_protocols() -> typing.List[str]

List of protocols the credential can be used for.

classsrc.spnego._credential.Password

Plaintext username and password credential.

methodsrc.spnego._credential.Password.supported_protocols() -> typing.List[str]

List of protocols the credential can be used for.

classsrc.spnego._credssp.CredSSPProxy

CredSSP proxy class CredSSP authentication.

classsrc.spnego._credssp_structures.NegoData

CredSSP NegoData structure.

methodsrc.spnego._credssp_structures.NegoData.pack() -> bytes

Packs the NegoData as a byte string.

methodsrc.spnego._credssp_structures.NegoData.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'NegoData'

Unpacks the NegoData TLV value.

classsrc.spnego._credssp_structures.TSCredentials

CredSSP TSCredentials structure.

methodsrc.spnego._credssp_structures.TSCredentials.cred_type() -> int

The credential type of credentials as an integer.

methodsrc.spnego._credssp_structures.TSCredentials.pack() -> bytes

Packs the TSCredentials as a byte string.

methodsrc.spnego._credssp_structures.TSCredentials.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSCredentials'

Unpacks the TSCredentials TLV value.

classsrc.spnego._credssp_structures.TSCspDataDetail

CredSSP TSCspDataDetail structure.

methodsrc.spnego._credssp_structures.TSCspDataDetail.pack() -> bytes

Packs the TSCspDataDetail as a byte string.

methodsrc.spnego._credssp_structures.TSCspDataDetail.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSCspDataDetail'

Unpacks the TSCspDataDetail TLV value.

classsrc.spnego._credssp_structures.TSPasswordCreds

CredSSP TSPasswordCreds structure.

methodsrc.spnego._credssp_structures.TSPasswordCreds.pack() -> bytes

Packs the TSPasswordCreds as a byte string.

methodsrc.spnego._credssp_structures.TSPasswordCreds.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSPasswordCreds'

Unpacks the TSPasswordCreds TLV value.

classsrc.spnego._credssp_structures.TSRemoteGuardCreds

CredSSP TSRemoteGuardCreds structure.

methodsrc.spnego._credssp_structures.TSRemoteGuardCreds.pack() -> bytes

Packs the TSRemoteGuardCreds as a byte string.

methodsrc.spnego._credssp_structures.TSRemoteGuardCreds.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSRemoteGuardCreds'

Unpacks the TSRemoteGuardCreds TLV value.

classsrc.spnego._credssp_structures.TSRemoteGuardPackageCred

CredSSP TSRemoteGuardPackageCred structure.

method

src.spnego._credssp_structures.TSRemoteGuardPackageCred.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSRemoteGuardPackageCred'

Unpacks the TSRemoteGuardPackageCred TLV value.

classsrc.spnego._credssp_structures.TSRequest

CredSSP TSRequest structure.

methodsrc.spnego._credssp_structures.TSRequest.pack() -> bytes

Packs the TSRequest as a byte string.

methodsrc.spnego._credssp_structures.TSRequest.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSRequest'

Unpacks the TSRequest TLV value.

classsrc.spnego._credssp_structures.TSSmartCardCreds

CredSSP TSSmartCardCreds structure.

methodsrc.spnego._credssp_structures.TSSmartCardCreds.pack() -> bytes

Packs the TSSmartCardCreds as a byte string.

methodsrc.spnego._credssp_structures.TSSmartCardCreds.unpack(b_data:typing.Union[ASN1Value, bytes]) -> 'TSSmartCardCreds'

Unpacks the TSSmartCardCreds TLV value.

classsrc.spnego._gss.GSSAPIProxy

GSSAPI proxy class for GSSAPI on Linux.

classsrc.spnego._kerberos.EncryptedData

Kerberos EncryptedData container.

classsrc.spnego._kerberos.KdcReqBody

The KRB_AS_REQ message.

classsrc.spnego._kerberos.KrbApRep

The KRB_AP_REP message.

classsrc.spnego._kerberos.KrbApReq

The KRB_AP_REQ message.

classsrc.spnego._kerberos.KrbAsRep

The KRB_AS_REP message.

classsrc.spnego._kerberos.KrbAsReq

The KRB_AS_REQ message.

classsrc.spnego._kerberos.KrbError

The KRB_ERROR message.

classsrc.spnego._kerberos.PAData

Kerberos PA-DATA.

classsrc.spnego._kerberos.PAETypeInfo2

Kerberos PA-ETYPE-INFO2 container.

classsrc.spnego._kerberos.Ticket

Kerberos Ticket.

funcsrc.spnego._kerberos.unpack_hostname(value:typing.Union[bytes, ASN1Value]) -> 'HostAddress'

Unpacks an ASN.1 value to a HostAddress.

funcsrc.spnego._kerberos.unpack_principal_name(value:typing.Union[bytes, ASN1Value]) -> 'PrincipalName'

Unpacks an ASN.1 value to a PrincipalName.

classsrc.spnego._negotiate.NegotiateProxy

A context wrapper for a Python managed SPNEGO context.

classsrc.spnego._ntlm.NTLMProxy

A context wrapper for a Python managed NTLM context.

classsrc.spnego._ntlm_raw.crypto.RC4Handle

RC4 class to wrap the underlying crypto function.

methodsrc.spnego._ntlm_raw.crypto.RC4Handle.reset() -> None

Reset's the cipher stream back to the original state.

methodsrc.spnego._ntlm_raw.crypto.RC4Handle.update(b_data:bytes) -> bytes

Update the RC4 stream and return the encrypted/decrypted bytes.

funcsrc.spnego._ntlm_raw.crypto.crc32(m:bytes) -> bytes

Simple wrapper function to generate a CRC32 checksum.

funcsrc.spnego._ntlm_raw.crypto.des(k:bytes, d:bytes) -> bytes

DES encryption.

funcsrc.spnego._ntlm_raw.crypto.desl(k:bytes, d:bytes) -> bytes

Encryption using the DES Long algorithm.

funcsrc.spnego._ntlm_raw.crypto.hmac_md5(key:bytes, data:bytes) -> bytes

Simple wrapper function for a HMAC MD5 digest.

func

src.spnego._ntlm_raw.crypto.kxkey(flags:int, session_base_key:bytes, lmowf:bytes, lm_response:bytes, server_challenge:bytes) -> bytes

NTLM KXKEY function.

funcsrc.spnego._ntlm_raw.crypto.md5(m:bytes) -> bytes

Simple wrapper to generate a MD5 checksum.

funcsrc.spnego._ntlm_raw.crypto.rc4init(k:bytes) -> RC4Handle

Initialization of the RC4 handle using the key specified.

funcsrc.spnego._ntlm_raw.crypto.rc4k(k:bytes, d:bytes) -> bytes

RC4 encryption with an explicit key.

funcsrc.spnego._ntlm_raw.crypto.sealkey(flags:int, session_key:bytes, usage:str) -> bytes

NTLM SEALKEY function.

funcsrc.spnego._ntlm_raw.crypto.signkey(flags:int, session_key:bytes, usage:str) -> bytes

NTLM SIGNKEY function.

classsrc.spnego._ntlm_raw.des.DES

Creates a DES cipher.

methodsrc.spnego._ntlm_raw.des.DES.decrypt(data:bytes) -> bytes

Decrypt a byte string.

methodsrc.spnego._ntlm_raw.des.DES.encrypt(data:bytes) -> bytes

Encrypt a byte string.

methodsrc.spnego._ntlm_raw.des.DES.key56_to_key64(key:bytes) -> bytes

Convert 7 byte key to 8 bytes.

funcsrc.spnego._ntlm_raw.md4.md4(data:bytes) -> bytes

Python implementation of md4 hashing.

methodsrc.spnego._ntlm_raw.messages.Authenticate.lm_challenge_response() -> typing.Optional[bytes]

The LmChallengeResponse or None if not set.

methodsrc.spnego._ntlm_raw.messages.Authenticate.mic() -> typing.Optional[bytes]

The MIC for the Authenticate message.

methodsrc.spnego._ntlm_raw.messages.Authenticate.nt_challenge_response() -> typing.Optional[bytes]

The NtChallengeResponse or None if not set.

methodsrc.spnego._ntlm_raw.messages.Authenticate.user_name() -> typing.Optional[str]

The name of the user to be authenticated.

methodsrc.spnego._ntlm_raw.messages.Authenticate.version() -> typing.Optional['Version']

The client NTLM version.

classsrc.spnego._ntlm_raw.messages.AvFlags

MsvAvFlags for an AV_PAIR.

classsrc.spnego._ntlm_raw.messages.AvId

ID for an NTLM AV_PAIR.

methodsrc.spnego._ntlm_raw.messages.Challenge.flags() -> int

The negotiate flags supported by the server.

methodsrc.spnego._ntlm_raw.messages.Challenge.server_challenge() -> bytes

The server's 8 byte nonce challenge.

methodsrc.spnego._ntlm_raw.messages.Challenge.target_name() -> typing.Optional[str]

The name of the server authentication realm.

methodsrc.spnego._ntlm_raw.messages.Challenge.version() -> typing.Optional['Version']

The server NTLM version.

classsrc.spnego._ntlm_raw.messages.FileTime

Windows FILETIME structure.

methodsrc.spnego._ntlm_raw.messages.FileTime.from_datetime(dt:datetime.datetime, ns:int=0) -> 'FileTime'

Creates a FileTime object from a datetime object.

methodsrc.spnego._ntlm_raw.messages.FileTime.pack() -> bytes

Packs the structure to bytes.

methodsrc.spnego._ntlm_raw.messages.FileTime.unpack(b_data:bytes) -> 'FileTime'

Unpacks the structure from bytes.

classsrc.spnego._ntlm_raw.messages.NTLMMessage

Base NTLM message class that defines the pack and unpack functions.

methodsrc.spnego._ntlm_raw.messages.NTLMMessage.pack() -> bytes

Packs the structure to bytes.

methodsrc.spnego._ntlm_raw.messages.NTLMMessage.unpack(b_data:bytes, encoding:typing.Optional[str]=None) -> 'NTLMMessage'

Unpacks the structure from bytes.

classsrc.spnego._ntlm_raw.messages.NegotiateFlags

NTLM Negotiation flags.

classsrc.spnego._ntlm_raw.messages.SingleHost

Single_Host_Data structure for NTLM TargetInfo entry.

methodsrc.spnego._ntlm_raw.messages.SingleHost.pack() -> bytes

Packs the structure to bytes.

methodsrc.spnego._ntlm_raw.messages.SingleHost.unpack(b_data:bytes) -> 'SingleHost'

Creates a SignleHost object from raw bytes.

methodsrc.spnego._ntlm_raw.messages.TargetInfo.pack() -> bytes

Packs the structure to bytes.

methodsrc.spnego._ntlm_raw.messages.TargetInfo.unpack(b_data:bytes) -> 'TargetInfo'

Unpacks the structure from bytes.

classsrc.spnego._ntlm_raw.messages.Version

A structure contains the OS information.

methodsrc.spnego._ntlm_raw.messages.Version.pack() -> bytes

Packs the structure to bytes.

methodsrc.spnego._ntlm_raw.messages.Version.unpack(b_data:bytes) -> 'Version'

Creates a Version object from raw bytes.

func

src.spnego._ntlm_raw.security.seal(flags:int, handle:RC4Handle, signing_key:bytes, seq_num:int, b_data:bytes, *to_sign:typing.Optional[bytes]=None) -> typing.Tuple[bytes, bytes]

Create a sealed NTLM message.

funcsrc.spnego._ntlm_raw.security.sign(flags:int, handle:RC4Handle, signing_key:bytes, seq_num:int, b_data:bytes) -> bytes

Create a NTLM signature.

classsrc.spnego._spnego.InitialContextToken

GSSAPI InitialContextToken object.

methodsrc.spnego._spnego.InitialContextToken.pack() -> bytes

Packs the InitialContextToken as a byte string.

methodsrc.spnego._spnego.InitialContextToken.unpack(b_data:bytes) -> 'InitialContextToken'

Unpacks the InitialContextToken TLV value.

classsrc.spnego._spnego.NegTokenInit

The NegTokenInit GSSAPI value.

methodsrc.spnego._spnego.NegTokenInit.pack() -> bytes

Packs the NegTokenInit as a byte string.

methodsrc.spnego._spnego.NegTokenInit.unpack(b_data:bytes) -> 'NegTokenInit'

Unpacks the NegTokenInit TLV value.

classsrc.spnego._spnego.NegTokenResp

The NegTokenResp GSSAPI value.

methodsrc.spnego._spnego.NegTokenResp.pack() -> bytes

Packs the NegTokenResp as a byte string.

methodsrc.spnego._spnego.NegTokenResp.unpack(b_data:bytes) -> 'NegTokenResp'

Unpacks the NegTokenResp TLV value.

func

src.spnego._spnego.pack_mech_type_list(mech_list:typing.Union[str, typing.List[str], typing.Tuple[str, ...], typing.Set[str]]) -> bytes

Packs a list of OIDs for the mechListMIC value.

classsrc.spnego._sspi.SSPIProxy

SSPI proxy class for pure SSPI on Windows.

classsrc.spnego.exceptions.ErrorCode

Common error codes for SPNEGO operations.

classsrc.spnego.exceptions.SpnegoError

Common error for SPNEGO exception.

methodsrc.spnego.exceptions.SpnegoError.nt_status() -> int

The Windows NT Status code that represents this error.

classsrc.spnego.iov.BufferType

Buffer types to use for an IOVBuffer type.

classsrc.spnego.iov.IOVBuffer

A buffer to pass as a list to :meth:`wrap_iov()`.

classsrc.spnego.iov.IOVResBuffer

Results of an IOV operation.

classsrc.spnego.tls.CredSSPTLSContext

A TLS context generated for CredSSP.

funcsrc.spnego.tls.default_tls_context(usage:str='initiate') -> CredSSPTLSContext

CredSSP TLSContext with sane defaults.

funcsrc.spnego.tls.get_certificate_public_key(data:bytes) -> bytes

Public key bytes of an X.509 Certificate.

About this data

These signatures were extracted from the public source of jborean93/pyspnego using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries