pub struct PyPrivateKey { /* private fields */ }Expand description
An asymmetric private key.
Supports RSA, EC (P-256, P-384, P-521), Ed25519, Ed448, and DSA keys. Load from PEM (optionally password-protected) or unencrypted PKCS#8 DER; serialize back to PEM (optionally encrypted with AES-256-CBC) or unencrypted PKCS#8 DER. RSA keys can decrypt ciphertext with OAEP or PKCS#1 v1.5 padding.
import synta
# Load an encrypted RSA private key from PEM:
with open("rsa_key.pem", "rb") as f:
priv = synta.PrivateKey.from_pem(f.read(), password=b"secret")
# Extract the public key:
pub = priv.public_key
# Decrypt RSA-OAEP ciphertext:
plaintext = priv.rsa_oaep_decrypt(ciphertext, "sha256")Trait Implementations§
impl DerefToPyAny for PyPrivateKey
impl ExtractPyClassWithClone for PyPrivateKey
Source§impl<'py> IntoPyObject<'py> for PyPrivateKey
impl<'py> IntoPyObject<'py> for PyPrivateKey
Source§type Target = PyPrivateKey
type Target = PyPrivateKey
The Python output type
Source§type Output = Bound<'py, <PyPrivateKey as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyPrivateKey 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 PrivateKey for PyPrivateKey
Implement the backend-agnostic synta_certificate::PrivateKey trait for
PyPrivateKey by delegating to synta_certificate::BackendPrivateKey.
impl PrivateKey for PyPrivateKey
Implement the backend-agnostic synta_certificate::PrivateKey trait for
PyPrivateKey by delegating to synta_certificate::BackendPrivateKey.
This allows Python binding code (e.g. cert_builder.rs) to call
key.as_signer(algorithm) without importing backend-specific types.
Source§fn public_key_spki_der(&self) -> Result<Vec<u8>, PrivateKeyError>
fn public_key_spki_der(&self) -> Result<Vec<u8>, PrivateKeyError>
Return the DER-encoded SubjectPublicKeyInfo for the public half of this key. Read more
Source§fn as_signer(&self, algorithm: &str) -> Box<dyn ErasedCertificateSigner>
fn as_signer(&self, algorithm: &str) -> Box<dyn ErasedCertificateSigner>
Create a
CertificateSigner for this key with the given hash algorithm. Read moreSource§impl PyClass for PyPrivateKey
impl PyClass for PyPrivateKey
Source§impl PyClassImpl for PyPrivateKey
impl PyClassImpl for PyPrivateKey
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 = /// An asymmetric private key.
///
/// Supports RSA, EC (P-256, P-384, P-521), Ed25519, Ed448, and DSA keys.
/// Load from PEM (optionally password-protected) or unencrypted PKCS\#8 DER;
/// serialize back to PEM (optionally encrypted with AES-256-CBC) or
/// unencrypted PKCS\#8 DER. RSA keys can decrypt ciphertext with OAEP or
/// PKCS\#1 v1.5 padding.
///
/// ```python,ignore
/// import synta
///
/// # Load an encrypted RSA private key from PEM:
/// with open("rsa_key.pem", "rb") as f:
/// priv = synta.PrivateKey.from_pem(f.read(), password=b"secret")
///
/// # Extract the public key:
/// pub = priv.public_key
///
/// # Decrypt RSA-OAEP ciphertext:
/// plaintext = priv.rsa_oaep_decrypt(ciphertext, "sha256")
/// ```
const RAW_DOC: &'static CStr = /// An asymmetric private key. /// /// Supports RSA, EC (P-256, P-384, P-521), Ed25519, Ed448, and DSA keys. /// Load from PEM (optionally password-protected) or unencrypted PKCS\#8 DER; /// serialize back to PEM (optionally encrypted with AES-256-CBC) or /// unencrypted PKCS\#8 DER. RSA keys can decrypt ciphertext with OAEP or /// PKCS\#1 v1.5 padding. /// /// ```python,ignore /// import synta /// /// # Load an encrypted RSA private key from PEM: /// with open("rsa_key.pem", "rb") as f: /// priv = synta.PrivateKey.from_pem(f.read(), password=b"secret") /// /// # Extract the public key: /// pub = priv.public_key /// /// # Decrypt RSA-OAEP ciphertext: /// plaintext = priv.rsa_oaep_decrypt(ciphertext, "sha256") /// ```
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<PyPrivateKey>
type ThreadChecker = SendablePyClass<PyPrivateKey>
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<PyPrivateKey> for PyClassImplCollector<PyPrivateKey>
impl PyMethods<PyPrivateKey> for PyClassImplCollector<PyPrivateKey>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyPrivateKey
impl PyTypeInfo for PyPrivateKey
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 PyPrivateKey
impl RefUnwindSafe for PyPrivateKey
impl Send for PyPrivateKey
impl Sync for PyPrivateKey
impl Unpin for PyPrivateKey
impl UnsafeUnpin for PyPrivateKey
impl UnwindSafe for PyPrivateKey
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.