pub struct PyPbes2ParamsBuilder { /* private fields */ }Expand description
Python-facing wrapper for synta_certificate::Pbes2ParamsBuilder.
Builds a DER-encoded Pkcs5Pbes2Params SEQUENCE (RFC 8018 §6.2).
Both key_derivation_func and encryption_scheme are required.
Typical usage:
- Build the PBKDF2
AlgorithmIdentifierusing :meth:Pbkdf2ParamsBuilder.build_as_algorithm_identifier. - Set the encryption scheme using :meth:
encryption_scheme_from_oid. - Call :meth:
build.
Example::
import synta
import synta.pkcs5 as pkcs5
salt = b"\\x00" * 8
iv = b"\\x00" * 16
kdf_der = (
synta.Pbkdf2ParamsBuilder()
.salt(salt)
.iteration_count(10_000)
.prf(list(pkcs5.ID_HMAC_WITH_SHA256.components()))
.build_as_algorithm_identifier(list(pkcs5.ID_PBKDF2.components()))
)
pbes2_der = (
synta.Pbes2ParamsBuilder()
.key_derivation_func(kdf_der)
.encryption_scheme_from_oid(list(pkcs5.AES256_CBC_PAD.components()), iv)
.build()
)Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for PyPbes2ParamsBuilder
impl<'py> IntoPyObject<'py> for PyPbes2ParamsBuilder
Source§type Target = PyPbes2ParamsBuilder
type Target = PyPbes2ParamsBuilder
The Python output type
Source§type Output = Bound<'py, <PyPbes2ParamsBuilder as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyPbes2ParamsBuilder 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 PyClass for PyPbes2ParamsBuilder
impl PyClass for PyPbes2ParamsBuilder
Source§impl PyClassImpl for PyPbes2ParamsBuilder
impl PyClassImpl for PyPbes2ParamsBuilder
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 = /// Python-facing wrapper for [`synta_certificate::Pbes2ParamsBuilder`].
///
/// Builds a DER-encoded ``Pkcs5Pbes2Params`` SEQUENCE (RFC 8018 §6.2).
///
/// Both ``key_derivation_func`` and ``encryption_scheme`` are required.
///
/// Typical usage:
///
/// 1. Build the PBKDF2 ``AlgorithmIdentifier`` using
/// :meth:`Pbkdf2ParamsBuilder.build_as_algorithm_identifier`.
/// 2. Set the encryption scheme using :meth:`encryption_scheme_from_oid`.
/// 3. Call :meth:`build`.
///
/// Example::
///
/// import synta
/// import synta.pkcs5 as pkcs5
///
/// salt = b"\\x00" * 8
/// iv = b"\\x00" * 16
///
/// kdf_der = (
/// synta.Pbkdf2ParamsBuilder()
/// .salt(salt)
/// .iteration_count(10_000)
/// .prf(list(pkcs5.ID_HMAC_WITH_SHA256.components()))
/// .build_as_algorithm_identifier(list(pkcs5.ID_PBKDF2.components()))
/// )
///
/// pbes2_der = (
/// synta.Pbes2ParamsBuilder()
/// .key_derivation_func(kdf_der)
/// .encryption_scheme_from_oid(list(pkcs5.AES256_CBC_PAD.components()), iv)
/// .build()
/// )
const RAW_DOC: &'static CStr = /// Python-facing wrapper for [`synta_certificate::Pbes2ParamsBuilder`]. /// /// Builds a DER-encoded ``Pkcs5Pbes2Params`` SEQUENCE (RFC 8018 §6.2). /// /// Both ``key_derivation_func`` and ``encryption_scheme`` are required. /// /// Typical usage: /// /// 1. Build the PBKDF2 ``AlgorithmIdentifier`` using /// :meth:`Pbkdf2ParamsBuilder.build_as_algorithm_identifier`. /// 2. Set the encryption scheme using :meth:`encryption_scheme_from_oid`. /// 3. Call :meth:`build`. /// /// Example:: /// /// import synta /// import synta.pkcs5 as pkcs5 /// /// salt = b"\\x00" * 8 /// iv = b"\\x00" * 16 /// /// kdf_der = ( /// synta.Pbkdf2ParamsBuilder() /// .salt(salt) /// .iteration_count(10_000) /// .prf(list(pkcs5.ID_HMAC_WITH_SHA256.components())) /// .build_as_algorithm_identifier(list(pkcs5.ID_PBKDF2.components())) /// ) /// /// pbes2_der = ( /// synta.Pbes2ParamsBuilder() /// .key_derivation_func(kdf_der) /// .encryption_scheme_from_oid(list(pkcs5.AES256_CBC_PAD.components()), iv) /// .build() /// )
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<PyPbes2ParamsBuilder>
type ThreadChecker = SendablePyClass<PyPbes2ParamsBuilder>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
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 PyPbes2ParamsBuilder
impl PyClassNewTextSignature for PyPbes2ParamsBuilder
const TEXT_SIGNATURE: &'static str = "()"
Source§impl PyMethods<PyPbes2ParamsBuilder> for PyClassImplCollector<PyPbes2ParamsBuilder>
impl PyMethods<PyPbes2ParamsBuilder> for PyClassImplCollector<PyPbes2ParamsBuilder>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyPbes2ParamsBuilder
impl PyTypeInfo for PyPbes2ParamsBuilder
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.
impl DerefToPyAny for PyPbes2ParamsBuilder
impl ExtractPyClassWithClone for PyPbes2ParamsBuilder
Auto Trait Implementations§
impl Freeze for PyPbes2ParamsBuilder
impl RefUnwindSafe for PyPbes2ParamsBuilder
impl Send for PyPbes2ParamsBuilder
impl Sync for PyPbes2ParamsBuilder
impl Unpin for PyPbes2ParamsBuilder
impl UnsafeUnpin for PyPbes2ParamsBuilder
impl UnwindSafe for PyPbes2ParamsBuilder
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.