# Struct openssl::ec::EcKey [−] [src]

    pub struct EcKey<T>(_, _);

Public and optional Private key on the given curve

OpenSSL documentation at `EC_KEY_new`

## Implementations

### `impl EcKey<Params>` [src]

#### `pub fn from_curve_name(nid: Nid) -> Result<EcKey<Params>, ErrorStack>` [src]

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`.

OpenSSL documenation at `EC_KEY_new_by_curve_name`

#### `pub fn from_group(group: &EcGroupRef) -> Result<EcKey<Params>, ErrorStack>` [src]

Constructs an `EcKey` corresponding to a curve.

This corresponds to `EC_KEY_set_group`.

### `impl EcKey<Public>` [src]

#### `pub fn from_public_key(
group: &EcGroupRef,
public_key: &EcPointRef
) -> Result<EcKey<Public>, ErrorStack>` [src]

Constructs an `EcKey` from the specified group with the associated `EcPoint`, public_key.

This will only have the associated public_key.

# Example

    use openssl::bn::BigNumContext;
    use openssl::ec::*;
    use openssl::nid::Nid;
    use openssl::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>` [src]

Constructs a public key from its affine coordinates.

#### `pub fn public_key_from_pem(pem: &[u8]) -> Result<EcKey<Public>, ErrorStack>` [src]

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>` [src]

Decodes a DER-encoded SubjectPublicKeyInfo structure containing a EC key.

This corresponds to `d2i_EC_PUBKEY`.

### `impl EcKey<Private>` [src]

#### `pub fn generate(group: &EcGroupRef) -> Result<EcKey<Private>, ErrorStack>` [src]

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>` [src]

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>` [src]

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>` [src]

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> where
F: FnOnce(&mut [u8]) -> Result<usize, ErrorStack>,` [src]

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>` [src]

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>` [src]

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>` [src]

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>` [src]

Serializes the private key into a DER-encoded ECPrivateKey structure.

This corresponds to `i2d_ECPrivateKey`.

#### `pub fn private_key(&self) -> &BigNumRef` [src]

Return `EcPoint` associated with the private key

OpenSSL documentation at `EC_KEY_get0_private_key`

#### `pub fn public_key(&self) -> &EcPointRef` [src]

Returns the public key.

OpenSSL documentation at `EC_KEY_get0_public_key`

#### `pub fn public_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>` [src]

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>` [src]

Serializes the public key into a DER-encoded SubjectPublicKeyInfo structure.

This corresponds to `i2d_EC_PUBKEY`.

#### `pub fn group(&self) -> &EcGroupRef` [src]

Return `EcGroup` of the `EcKey`

OpenSSL documentation at `EC_KEY_get0_group`

#### `pub fn check_key(&self) -> Result<(), ErrorStack>` [src]

Checks the key for validity.

OpenSSL documenation at `EC_KEY_check_key`

## Trait Implementations

### `impl<T> AsRef<EcKeyRef<T>> for EcKey<T>` [src]

#### `fn as_ref(&self) -> &EcKeyRef<T>` [src]

Performs the conversion.

### `impl<T> Borrow<EcKeyRef<T>> for EcKey<T>` [src]

#### `fn borrow(&self) -> &EcKeyRef<T>` [src]

Immutably borrows from an owned value. Read more

### `impl<T> Clone for EcKey<T>` [src]

#### `fn clone(&self) -> EcKey<T>` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl<T> Debug for EcKey<T>` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<T> Deref for EcKey<T>` [src]

#### `type Target = EcKeyRef<T>`

The resulting type after dereferencing.

#### `fn deref(&self) -> &EcKeyRef<T>` [src]

Dereferences the value.

### `impl<T> DerefMut for EcKey<T>` [src]

#### `fn deref_mut(&mut self) -> &mut EcKeyRef<T>` [src]

Mutably dereferences the value.

### `impl<T> Drop for EcKey<T>` [src]

#### `fn drop(&mut self)` [src]

Executes the destructor for this type. Read more

### `impl<T> ForeignType for EcKey<T>` [src]

#### `type CType = EC_KEY`

The raw C type.

#### `type Ref = EcKeyRef<T>`

The type representing a reference to this type.

#### `unsafe fn from_ptr(ptr: *mut EC_KEY) -> EcKey<T>` [src]

Constructs an instance of this type from its raw type.

#### `fn as_ptr(&self) -> *mut EC_KEY` [src]

Returns a raw pointer to the wrapped value.

### `impl<T> Send for EcKey<T>` [src]

### `impl<T> Sync for EcKey<T>` [src]

## Auto Trait Implementations

### `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<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.