Skip to main content

PyMlDsaPrivateKey

Struct PyMlDsaPrivateKey 

Source
pub struct PyMlDsaPrivateKey { /* private fields */ }
Expand description

A parsed ML-DSA private key (RFC 9881 / FIPS 204).

ML-DSA private keys are DER-encoded CHOICE structures with three possible representations:

  • "seed" — only the 32-octet seed; the expanded key is rederived on use.
  • "expanded_key" — only the pre-expanded key material; faster signing.
  • "both" — seed and expanded key stored together.

The :attr:parameter_set property exposes the algorithm :class:~synta.ObjectIdentifier (one of synta.oids.ML_DSA_44, synta.oids.ML_DSA_65, or synta.oids.ML_DSA_87).

Use :meth:from_der to decode the privateKey value bytes from a OneAsymmetricKey / PKCS#8 structure. Pass the algorithm OID from the OneAsymmetricKey.algorithm field so the correct parameter set is used automatically.

Trait Implementations§

Source§

impl DerefToPyAny for PyMlDsaPrivateKey

Source§

impl ExtractPyClassWithClone for PyMlDsaPrivateKey

Source§

impl<'py> IntoPyObject<'py> for PyMlDsaPrivateKey

Source§

type Target = PyMlDsaPrivateKey

The Python output type
Source§

type Output = Bound<'py, <PyMlDsaPrivateKey as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for PyMlDsaPrivateKey

Source§

type Frozen = True

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for PyMlDsaPrivateKey

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// A parsed ML-DSA private key (RFC 9881 / FIPS 204). /// /// ML-DSA private keys are DER-encoded ``CHOICE`` structures with three /// possible representations: /// /// - ``"seed"`` — only the 32-octet seed; the expanded key is rederived on use. /// - ``"expanded_key"`` — only the pre-expanded key material; faster signing. /// - ``"both"`` — seed and expanded key stored together. /// /// The :attr:`parameter_set` property exposes the algorithm /// :class:`~synta.ObjectIdentifier` (one of ``synta.oids.ML_DSA_44``, /// ``synta.oids.ML_DSA_65``, or ``synta.oids.ML_DSA_87``). /// /// Use :meth:`from_der` to decode the ``privateKey`` value bytes from a /// ``OneAsymmetricKey`` / PKCS\#8 structure. Pass the algorithm OID from the /// ``OneAsymmetricKey.algorithm`` field so the correct parameter set is used /// automatically.

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<PyMlDsaPrivateKey>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

Source§

fn dict_offset() -> Option<isize>

Source§

fn weaklist_offset() -> Option<isize>

Source§

impl PyMethods<PyMlDsaPrivateKey> for PyClassImplCollector<PyMlDsaPrivateKey>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for PyMlDsaPrivateKey

Source§

const NAME: &'static str = "MlDsaPrivateKey"

Class name.
Source§

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
Source§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
Source§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
Source§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

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§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

Source§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

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.
Source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,