cryptnoxpro.command.user_keys package

Subpackages

• cryptnoxpro.command.user_keys.aws_kms package
  • Submodules
  • cryptnoxpro.command.user_keys.aws_kms.aws_kms module
  • Module contents
• cryptnoxpro.command.user_keys.hello package
  • Submodules
  • cryptnoxpro.command.user_keys.hello.exceptions module
  • cryptnoxpro.command.user_keys.hello.hello module
  • cryptnoxpro.command.user_keys.hello.windows_hello module
  • Module contents
• cryptnoxpro.command.user_keys.piv package
  • Submodules
  • cryptnoxpro.command.user_keys.piv.piv module
  • cryptnoxpro.command.user_keys.piv.piv_card module
  • Module contents

Submodules

cryptnoxpro.command.user_keys.authentication module

cryptnoxpro.command.user_keys.user_key_base module

Module containing base class for user key.

exception cryptnoxpro.command.user_keys.user_key_base.UserKeyException

Bases: Exception

Base exception for all exceptions for UserKey

exception cryptnoxpro.command.user_keys.user_key_base.ExitException

Bases: UserKeyException

The user has exited the request

exception cryptnoxpro.command.user_keys.user_key_base.NotFoundException

Bases: UserKeyException

The user key hasn’t been found

exception cryptnoxpro.command.user_keys.user_key_base.NotSupportedException

Bases: UserKeyException

The user key is not supported

exception cryptnoxpro.command.user_keys.user_key_base.ProcessingException

Bases: UserKeyException

There was an issue in processing the user key

class cryptnoxpro.command.user_keys.user_key_base.UserKey(target: str = '')

Bases: object

Base class on top of which other user key classes should be implemented

priority: int = 0

__init__(target: str = '')

abstractmethod delete() → None

Delete the key from the user key provider

abstract property description: str

Description of the user key service :rtype: str

Type:

return

abstract property name: str

Name of the user key service :rtype: str

Type:

return

abstract property public_key: bytes

Public key of the user key service :rtype: bytes

Type:

return

abstractmethod sign(message: bytes) → bytes

Get signature of message from user key service

Parameters:

message (bytes) – Message to sign

Returns:

Signature of the given message

Return type:

bytes

abstract property slot_index: cryptnoxpy.SlotIndex

Compatible slot index on the card :rtype: cryptnoxpy.SlotIndex

Type:

return

property custom_bit: int

Custom bit to use for checking if method is enabled, -1 for not used :rtype: int

Type:

return

added(card)

classmethod enabled(card: cryptnoxpy.Card) → bool

Module contents

The cryptnoxpro.command.user_keys package provides authentication functionality and exports:

cryptnoxpro.command.user_keys.add(data)

Add a new authentication method. See cryptnoxpro.command.user_keys.authentication.add() for details.

cryptnoxpro.command.user_keys.authenticate(data)

Authenticate using a configured method. See cryptnoxpro.command.user_keys.authentication.authenticate() for details.

cryptnoxpro.command.user_keys.delete(data)

Delete an authentication method. See cryptnoxpro.command.user_keys.authentication.delete() for details.

cryptnoxpro.command.user_keys.get(data)

Get information about authentication methods. See cryptnoxpro.command.user_keys.authentication.get() for details.