Struct EcKey
pub struct EcKey<T>(/* private fields */);
Expand description
Public and optional Private key on the given curve
Implementations§
§impl EcKey<Params>
impl EcKey<Params>
pub fn from_curve_name(nid: Nid) -> Result<EcKey<Params>, ErrorStack>
pub fn from_curve_name(nid: Nid) -> Result<EcKey<Params>, ErrorStack>
Constructs an EcKey
corresponding to a known curve.
It will not have an associated public or private key. This kind of key is primarily useful
to be provided to the set_tmp_ecdh
methods on Ssl
and SslContextBuilder
.
This corresponds to EC_KEY_new_by_curve_name
.
pub fn from_group(group: &EcGroupRef) -> Result<EcKey<Params>, ErrorStack>
pub fn from_group(group: &EcGroupRef) -> Result<EcKey<Params>, ErrorStack>
Constructs an EcKey
corresponding to a curve.
This corresponds to EC_KEY_set_group
.
§impl EcKey<Public>
impl EcKey<Public>
pub fn from_public_key(
group: &EcGroupRef,
public_key: &EcPointRef,
) -> Result<EcKey<Public>, ErrorStack>
pub fn from_public_key( group: &EcGroupRef, public_key: &EcPointRef, ) -> Result<EcKey<Public>, ErrorStack>
Constructs an EcKey
from the specified group with the associated EcPoint
, public_key.
This will only have the associated public_key.
§Example
use rama_boring::bn::BigNumContext;
use rama_boring::ec::*;
use rama_boring::nid::Nid;
use rama_boring::pkey::PKey;
// get bytes from somewhere, i.e. this will not produce a valid key
let public_key: Vec<u8> = vec![];
// create an EcKey from the binary form of a EcPoint
let group = EcGroup::from_curve_name(Nid::SECP256K1).unwrap();
let mut ctx = BigNumContext::new().unwrap();
let point = EcPoint::from_bytes(&group, &public_key, &mut ctx).unwrap();
let key = EcKey::from_public_key(&group, &point);
pub fn from_public_key_affine_coordinates(
group: &EcGroupRef,
x: &BigNumRef,
y: &BigNumRef,
) -> Result<EcKey<Public>, ErrorStack>
pub fn from_public_key_affine_coordinates( group: &EcGroupRef, x: &BigNumRef, y: &BigNumRef, ) -> Result<EcKey<Public>, ErrorStack>
Constructs a public key from its affine coordinates.
pub fn public_key_from_pem(pem: &[u8]) -> Result<EcKey<Public>, ErrorStack>
pub fn public_key_from_pem(pem: &[u8]) -> Result<EcKey<Public>, ErrorStack>
Decodes a PEM-encoded SubjectPublicKeyInfo structure containing a EC key.
The input should have a header of -----BEGIN PUBLIC KEY-----
.
This corresponds to PEM_read_bio_EC_PUBKEY
.
pub fn public_key_from_der(der: &[u8]) -> Result<EcKey<Public>, ErrorStack>
pub fn public_key_from_der(der: &[u8]) -> Result<EcKey<Public>, ErrorStack>
Decodes a DER-encoded SubjectPublicKeyInfo structure containing a EC key.
This corresponds to d2i_EC_PUBKEY
.
§impl EcKey<Private>
impl EcKey<Private>
pub fn generate(group: &EcGroupRef) -> Result<EcKey<Private>, ErrorStack>
pub fn generate(group: &EcGroupRef) -> Result<EcKey<Private>, ErrorStack>
Generates a new public/private key pair on the specified curve.
pub fn from_private_components(
group: &EcGroupRef,
private_number: &BigNumRef,
public_key: &EcPointRef,
) -> Result<EcKey<Private>, ErrorStack>
pub fn from_private_components( group: &EcGroupRef, private_number: &BigNumRef, public_key: &EcPointRef, ) -> Result<EcKey<Private>, ErrorStack>
Constructs an public/private key pair given a curve, a private key and a public key point.
pub fn private_key_from_pem(pem: &[u8]) -> Result<EcKey<Private>, ErrorStack>
pub fn private_key_from_pem(pem: &[u8]) -> Result<EcKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded ECPrivateKey structure.
The input should have a header of -----BEGIN EC PRIVATE KEY-----
.
This corresponds to PEM_read_bio_ECPrivateKey
.
pub fn private_key_from_pem_passphrase(
pem: &[u8],
passphrase: &[u8],
) -> Result<EcKey<Private>, ErrorStack>
pub fn private_key_from_pem_passphrase( pem: &[u8], passphrase: &[u8], ) -> Result<EcKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded encrypted ECPrivateKey structure.
The input should have a header of -----BEGIN EC PRIVATE KEY-----
.
This corresponds to PEM_read_bio_ECPrivateKey
.
pub fn private_key_from_pem_callback<F>(
pem: &[u8],
callback: F,
) -> Result<EcKey<Private>, ErrorStack>
pub fn private_key_from_pem_callback<F>( pem: &[u8], callback: F, ) -> Result<EcKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded encrypted ECPrivateKey structure.
The callback should fill the password into the provided buffer and return its length.
The input should have a header of -----BEGIN EC PRIVATE KEY-----
.
This corresponds to PEM_read_bio_ECPrivateKey
.
pub fn private_key_from_der(der: &[u8]) -> Result<EcKey<Private>, ErrorStack>
pub fn private_key_from_der(der: &[u8]) -> Result<EcKey<Private>, ErrorStack>
Decodes a DER-encoded elliptic curve private key structure.
This corresponds to d2i_ECPrivateKey
.
Methods from Deref<Target = EcKeyRef<T>>§
pub fn private_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>
Serializes the private key to a PEM-encoded ECPrivateKey structure.
The output will have a header of -----BEGIN EC PRIVATE KEY-----
.
This corresponds to PEM_write_bio_ECPrivateKey
.
pub fn private_key_to_pem_passphrase(
&self,
cipher: Cipher,
passphrase: &[u8],
) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_pem_passphrase( &self, cipher: Cipher, passphrase: &[u8], ) -> Result<Vec<u8>, ErrorStack>
Serializes the private key to a PEM-encoded encrypted ECPrivateKey structure.
The output will have a header of -----BEGIN EC PRIVATE KEY-----
.
This corresponds to PEM_write_bio_ECPrivateKey
.
pub fn private_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
Serializes the private key into a DER-encoded ECPrivateKey structure.
This corresponds to i2d_ECPrivateKey
.
pub fn private_key(&self) -> &BigNumRef
pub fn private_key(&self) -> &BigNumRef
Return EcPoint
associated with the private key
This corresponds to EC_KEY_get0_private_key
.
pub fn public_key(&self) -> &EcPointRef
pub fn public_key(&self) -> &EcPointRef
Returns the public key.
This corresponds to EC_KEY_get0_public_key
.
pub fn public_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>
pub fn public_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>
Serialies the public key into a PEM-encoded SubjectPublicKeyInfo structure.
The output will have a header of -----BEGIN PUBLIC KEY-----
.
This corresponds to PEM_write_bio_EC_PUBKEY
.
pub fn public_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
pub fn public_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
Serializes the public key into a DER-encoded SubjectPublicKeyInfo structure.
This corresponds to i2d_EC_PUBKEY
.
pub fn group(&self) -> &EcGroupRef
pub fn group(&self) -> &EcGroupRef
Return EcGroup
of the EcKey
This corresponds to EC_KEY_get0_group
.
pub fn check_key(&self) -> Result<(), ErrorStack>
pub fn check_key(&self) -> Result<(), ErrorStack>
Checks the key for validity.
This corresponds to EC_KEY_check_key
.
Trait Implementations§
§impl<T> ForeignType for EcKey<T>
impl<T> ForeignType for EcKey<T>
impl<T> Send for EcKey<T>
impl<T> Sync for EcKey<T>
Auto Trait Implementations§
impl<T> Freeze for EcKey<T>
impl<T> RefUnwindSafe for EcKey<T>where
T: RefUnwindSafe,
impl<T> Unpin for EcKey<T>where
T: Unpin,
impl<T> UnwindSafe for EcKey<T>where
T: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more