pub struct PyHOTP { /* private fields */ }Expand description
HMAC-based One-Time Password generator (RFC 4226).
Generates and verifies counter-based OTPs using HMAC-SHA1 (default), HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.
import synta.crypto
# RFC 4226 test vector — key is the ASCII string "12345678901234567890"
key = bytes.fromhex("3132333435363738393031323334353637383930")
hotp = synta.crypto.HOTP(key, digits=6, algorithm="sha1")
print(hotp.generate(0)) # "755224"
print(hotp.generate(1)) # "287082"
# Verify with look-ahead window of 5:
next_counter = hotp.verify("287082", counter=0, look_ahead=5)
assert next_counter == 1Trait Implementations§
impl DerefToPyAny for PyHOTP
impl ExtractPyClassWithClone for PyHOTP
Source§impl<'py> IntoPyObject<'py> for PyHOTP
impl<'py> IntoPyObject<'py> for PyHOTP
Source§type Output = Bound<'py, <PyHOTP as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyHOTP as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClassImpl for PyHOTP
impl PyClassImpl for PyHOTP
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// HMAC-based One-Time Password generator (RFC 4226).
///
/// Generates and verifies counter-based OTPs using HMAC-SHA1 (default),
/// HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512.
///
/// ```python,ignore
/// import synta.crypto
///
/// # RFC 4226 test vector — key is the ASCII string "12345678901234567890"
/// key = bytes.fromhex("3132333435363738393031323334353637383930")
/// hotp = synta.crypto.HOTP(key, digits=6, algorithm="sha1")
/// print(hotp.generate(0)) # "755224"
/// print(hotp.generate(1)) # "287082"
/// # Verify with look-ahead window of 5:
/// next_counter = hotp.verify("287082", counter=0, look_ahead=5)
/// assert next_counter == 1
/// ```
const RAW_DOC: &'static CStr = /// HMAC-based One-Time Password generator (RFC 4226). /// /// Generates and verifies counter-based OTPs using HMAC-SHA1 (default), /// HMAC-SHA256, HMAC-SHA384, or HMAC-SHA512. /// /// ```python,ignore /// import synta.crypto /// /// # RFC 4226 test vector — key is the ASCII string "12345678901234567890" /// key = bytes.fromhex("3132333435363738393031323334353637383930") /// hotp = synta.crypto.HOTP(key, digits=6, algorithm="sha1") /// print(hotp.generate(0)) # "755224" /// print(hotp.generate(1)) # "287082" /// # Verify with look-ahead window of 5: /// next_counter = hotp.verify("287082", counter=0, look_ahead=5) /// assert next_counter == 1 /// ```
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyHOTP>
type ThreadChecker = SendablePyClass<PyHOTP>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
The closest native ancestor. This is
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
fn dict_offset() -> Option<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for PyHOTP
impl PyClassNewTextSignature for PyHOTP
const TEXT_SIGNATURE: &'static str = "(key, digits=6, algorithm=\"sha1\")"
Source§impl PyMethods<PyHOTP> for PyClassImplCollector<PyHOTP>
impl PyMethods<PyHOTP> for PyClassImplCollector<PyHOTP>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyHOTP
impl PyTypeInfo for PyHOTP
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
Auto Trait Implementations§
impl Freeze for PyHOTP
impl RefUnwindSafe for PyHOTP
impl Send for PyHOTP
impl Sync for PyHOTP
impl Unpin for PyHOTP
impl UnsafeUnpin for PyHOTP
impl UnwindSafe for PyHOTP
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0:
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.