pub struct PyFernet { /* private fields */ }Expand description
Fernet symmetric authenticated encryption.
Implements the Fernet specification <https://github.com/fernet/spec/blob/master/Spec.md>_
using AES-128-CBC encryption and HMAC-SHA256 authentication. Tokens
produced by this class are byte-for-byte compatible with those produced
by cryptography.fernet.Fernet.
Key format: a URL-safe base64-encoded string of 32 raw bytes, where the first 16 bytes are the signing key and the last 16 bytes are the encryption key.
Token format (before base64url encoding):
- 1 byte: version (
0x80) - 8 bytes: timestamp (big-endian unsigned 64-bit Unix seconds)
- 16 bytes: AES-CBC initialization vector
- N bytes: AES-128-CBC ciphertext (PKCS#7-padded plaintext)
- 32 bytes: HMAC-SHA256 of all preceding bytes
import synta
key = synta.Fernet.generate_key()
fern = synta.Fernet(key)
token = fern.encrypt(b"secret data")
plain = fern.decrypt(token)
assert plain == b"secret data"
# TTL check (seconds):
plain = fern.decrypt(token, ttl=300)Trait Implementations§
impl DerefToPyAny for PyFernet
impl ExtractPyClassWithClone for PyFernet
Source§impl<'py> IntoPyObject<'py> for PyFernet
impl<'py> IntoPyObject<'py> for PyFernet
Source§type Output = Bound<'py, <PyFernet as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyFernet 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 PyFernet
impl PyClassImpl for PyFernet
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 = /// Fernet symmetric authenticated encryption.
///
/// Implements the `Fernet specification <https://github.com/fernet/spec/blob/master/Spec.md>`_
/// using AES-128-CBC encryption and HMAC-SHA256 authentication. Tokens
/// produced by this class are byte-for-byte compatible with those produced
/// by ``cryptography.fernet.Fernet``.
///
/// **Key format:** a URL-safe base64-encoded string of 32 raw bytes, where
/// the first 16 bytes are the signing key and the last 16 bytes are the
/// encryption key.
///
/// **Token format (before base64url encoding):**
///
/// * 1 byte: version (``0x80``)
/// * 8 bytes: timestamp (big-endian unsigned 64-bit Unix seconds)
/// * 16 bytes: AES-CBC initialization vector
/// * N bytes: AES-128-CBC ciphertext (PKCS#7-padded plaintext)
/// * 32 bytes: HMAC-SHA256 of all preceding bytes
///
/// ```python,ignore
/// import synta
///
/// key = synta.Fernet.generate_key()
/// fern = synta.Fernet(key)
/// token = fern.encrypt(b"secret data")
/// plain = fern.decrypt(token)
/// assert plain == b"secret data"
///
/// # TTL check (seconds):
/// plain = fern.decrypt(token, ttl=300)
/// ```
const RAW_DOC: &'static CStr = /// Fernet symmetric authenticated encryption. /// /// Implements the `Fernet specification <https://github.com/fernet/spec/blob/master/Spec.md>`_ /// using AES-128-CBC encryption and HMAC-SHA256 authentication. Tokens /// produced by this class are byte-for-byte compatible with those produced /// by ``cryptography.fernet.Fernet``. /// /// **Key format:** a URL-safe base64-encoded string of 32 raw bytes, where /// the first 16 bytes are the signing key and the last 16 bytes are the /// encryption key. /// /// **Token format (before base64url encoding):** /// /// * 1 byte: version (``0x80``) /// * 8 bytes: timestamp (big-endian unsigned 64-bit Unix seconds) /// * 16 bytes: AES-CBC initialization vector /// * N bytes: AES-128-CBC ciphertext (PKCS#7-padded plaintext) /// * 32 bytes: HMAC-SHA256 of all preceding bytes /// /// ```python,ignore /// import synta /// /// key = synta.Fernet.generate_key() /// fern = synta.Fernet(key) /// token = fern.encrypt(b"secret data") /// plain = fern.decrypt(token) /// assert plain == b"secret data" /// /// # TTL check (seconds): /// plain = fern.decrypt(token, ttl=300) /// ```
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<PyFernet>
type ThreadChecker = SendablePyClass<PyFernet>
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 PyMethods<PyFernet> for PyClassImplCollector<PyFernet>
impl PyMethods<PyFernet> for PyClassImplCollector<PyFernet>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyFernet
impl PyTypeInfo for PyFernet
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 PyFernet
impl RefUnwindSafe for PyFernet
impl Send for PyFernet
impl Sync for PyFernet
impl Unpin for PyFernet
impl UnsafeUnpin for PyFernet
impl UnwindSafe for PyFernet
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.