This module hosts available auth types for encoding and matching user keys. For adding a new auth type, simply write a class that satisfies the following conditions:
Maximum length any valid token should ever be.
Bases: object
Provides a particular auth type for encoding format for encoding and matching user keys.
This class must be all lowercase except for the first character, which must be capitalized. encode and match methods must be provided and are the only ones that will be used by swauth.
Encodes a user key into a particular format. The result of this method will be used by swauth for storing user credentials.
Parameters: | key – User’s secret key |
---|---|
Returns: | A string representing user credentials |
Checks whether the user-provided key matches the user’s credentials
Parameters: |
|
---|---|
Returns: | True if the supplied key is valid, False otherwise |
Validate user credentials whether format is right for Plaintext
Parameters: | auth_rest – User credentials’ part without auth_type |
---|---|
Returns: | Dict with a hash part of user credentials |
Raises ValueError: | |
If credentials’ part has zero length |
Bases: object
Provides a particular auth type for encoding format for encoding and matching user keys.
This class must be all lowercase except for the first character, which must be capitalized. encode and match methods must be provided and are the only ones that will be used by swauth.
Encodes a user key into a particular format. The result of this method will be used by swauth for storing user credentials.
If salt is not manually set in conf file, a random salt will be generated and used.
Parameters: | key – User’s secret key |
---|---|
Returns: | A string representing user credentials |
Encodes a user key with salt into a particular format. The result of this method will be used internally.
Parameters: |
|
---|---|
Returns: | A string representing user credentials |
Checks whether the user-provided key matches the user’s credentials
Parameters: |
|
---|---|
Returns: | True if the supplied key is valid, False otherwise |
Validate user credentials whether format is right for Sha1
Parameters: | auth_rest – User credentials’ part without auth_type |
---|---|
Returns: | Dict with a hash and a salt part of user credentials |
Raises ValueError: | |
If credentials’ part doesn’t contain delimiter between a salt and a hash. |
Bases: object
Provides a particular auth type for encoding format for encoding and matching user keys.
This class must be all lowercase except for the first character, which must be capitalized. encode and match methods must be provided and are the only ones that will be used by swauth.
Encodes a user key into a particular format. The result of this method will be used by swauth for storing user credentials.
If salt is not manually set in conf file, a random salt will be generated and used.
Parameters: | key – User’s secret key |
---|---|
Returns: | A string representing user credentials |
Encodes a user key with salt into a particular format. The result of this method will be used internal.
Parameters: |
|
---|---|
Returns: | A string representing user credentials |
Checks whether the user-provided key matches the user’s credentials
Parameters: |
|
---|---|
Returns: | True if the supplied key is valid, False otherwise |
Validate user credentials whether format is right for Sha512
Parameters: | auth_rest – User credentials’ part without auth_type |
---|---|
Returns: | Dict with a hash and a salt part of user credentials |
Raises ValueError: | |
If credentials’ part doesn’t contain delimiter between a salt and a hash. |
Parse and validate user credentials whether format is right
Parameters: | creds – User credentials |
---|---|
Returns: | Auth_type class instance and parsed user credentials in dict |
Raises ValueError: | |
If credential format is wrong (eg: bad auth_type) |