//! All the traits of this crate.

use downcast_rs::{impl_downcast, Downcast};

use rand::{CryptoRng, RngCore};

use ssh_key::{

    private::{Ed25519Keypair, Ed25519PrivateKey, KeypairData, OpaqueKeypair},

    public::{Ed25519PublicKey, KeyData, OpaquePublicKey},

    Algorithm, AlgorithmName,

};

use tor_error::internal;

use tor_llcrypto::{

    pk::{curve25519, ed25519},

    rng::EntropicRng,

};

use crate::certs::CertData;

use crate::key_type::CertType;

use crate::{

    ssh::{SshKeyData, ED25519_EXPANDED_ALGORITHM_NAME, X25519_ALGORITHM_NAME},

    ErasedKey, KeyType, KeystoreItemType, Result,

};

use std::result::Result as StdResult;

/// A random number generator for generating [`EncodableItem`]s.

pub trait KeygenRng: RngCore + CryptoRng + EntropicRng {}

impl<T> KeygenRng for T where T: RngCore + CryptoRng + EntropicRng {}

/// A trait for generating fresh keys.

pub trait Keygen {

    /// Generate a new key of this type.

    fn generate(rng: &mut dyn KeygenRng) -> Result<Self>

    where

        Self: Sized;

}

/// A trait for getting the type of an item.

pub trait ItemType: Downcast {

    /// The type of the key.

    fn item_type() -> KeystoreItemType

    where

        Self: Sized;

}

impl_downcast!(ItemType);

/// A key that can be serialized to, and deserialized from.

//

// When adding a new `EncodableItem` impl, you must also update

// [`SshKeyData::into_erased`](crate::SshKeyData::into_erased) to

// return the corresponding concrete type implementing `EncodableItem`

// (as a `dyn EncodableItem`).

pub trait EncodableItem: ItemType + Downcast {

    /// Return the key as a [`KeystoreItem`].

    fn as_keystore_item(&self) -> Result<KeystoreItem>;

}

impl_downcast!(EncodableItem);

/// A public key, keypair, or key certificate.

#[derive(Debug, Clone, derive_more::From)]

#[non_exhaustive]

pub enum KeystoreItem {

    /// A public key or a keypair.

    Key(SshKeyData),

    /// A certificate.

    Cert(CertData),

}

impl KeystoreItem {

    /// Return the [`KeystoreItemType`] of this item.

        }

    /// Convert the key/cert material into a known type,

    /// and return the type-erased value.

    ///

    /// The caller is expected to downcast the value returned to the correct concrete type.

        }

}

/// A key that can be converted to an [`EncodableItem`].

//

// NOTE: Conceptually, the `ToEncodableKey` and `EncodableItem` traits serve the same purpose (they

// provide information about how to encode/decode a key).

//

// The reason we have two traits instead of just one is because `EncodableItem` cannot have an

// associated type: for instance, if it did, we'd need to either give

// `tor-keymgr::Keystore::insert` a generic parameter (which would make `Keystore` object-unsafe),

// or specify a concrete type for the associated type of the `EncodableItem` (which would defeat the

// whole purpose of the trait, i.e. to enable users to store their own "encodable key" types).

//

// `ToEncodableKey` is used in the `KeyMgr` impl, where the associated type isn't an issue because

// the `KeyMgr` implementation is generic over `K: ToEncodableKey`. The `Keystore`s themselves only

// receive `&dyn EncodableItem`s.

//

pub trait ToEncodableKey: From<Self::KeyPair>

where

    Self::Key: From<<Self::KeyPair as ToEncodableKey>::Key>,

{

    /// The key type this can be converted to/from.

    type Key: EncodableItem + 'static;

    /// The KeyPair (secret+public) of which this key is a subset.  For secret

    /// keys, this type is Self.  For public keys, this type is the

    /// corresponding (secret) keypair.

    ///

    /// The associated type constraint (`where`) expresses the fact that a

    /// public key is always derivable from its corresponding secret key.

    ///

    type KeyPair: ToEncodableKey;

    /// Convert this key to a type that implements [`EncodableItem`].

    fn to_encodable_key(self) -> Self::Key;

    /// Convert an [`EncodableItem`] to another key type.

    fn from_encodable_key(key: Self::Key) -> Self;

}

/// A trait representing an encodable certificate.

///

/// `K` represents the (Rust) type of the subject key.

pub trait ToEncodableCert<K: ToEncodableKey>: Clone {

    /// The low-level type this can be converted from.

    type ParsedCert: ItemType + 'static;

    /// The low-level type this can be converted to.

    type EncodableCert: EncodableItem + 'static;

    /// The (Rust) type of the signing key.

    type SigningKey: ToEncodableKey;

    /// Validate this certificate.

    //

    // This function will be called from functions such as KeyMgr::get_key_and_cert()

    // to validate the cert using the provided subject key

    // (the concrete type of which is given by the `K` in KeyMgr::get_key_and_cert())

    // and ToEncodableCert::SigningKey.

    //

    /// This function should return an error if

    ///   * the certificate is not timely

    ///     (i.e. it is expired, or not yet valid), or

    ///   * the certificate is not well-signed, or

    ///   * the subject key or signing key in the certificate do not match

    ///     the subject and signing keys specified in `cert_spec`

    fn validate(

        cert: Self::ParsedCert,

        subject: &K,

        signed_with: &Self::SigningKey,

    ) -> StdResult<Self, InvalidCertError>;

    /// Convert this cert to a type that implements [`EncodableItem`].

    fn to_encodable_cert(self) -> Self::EncodableCert;

}

/// The error type returned by [`ToEncodableCert::validate`].

#[derive(thiserror::Error, Debug, Clone)]

#[non_exhaustive]

pub enum InvalidCertError {

    /// An error caused by a key certificate with an invalid signature.

    #[error("Invalid signature")]

    CertSignature(#[from] tor_cert::CertError),

    /// An error caused by an untimely key certificate.

    #[error("Certificate is expired or not yet valid")]

    TimeValidity(#[from] tor_checkable::TimeValidityError),

    /// A key certificate with an unexpected subject key algorithm.

    #[error("Unexpected subject key algorithm")]

    InvalidSubjectKeyAlgorithm,

    /// An error caused by a key certificate with an unexpected subject key.

    #[error("Certificate certifies the wrong key")]

    SubjectKeyMismatch,

    /// An error caused by a key certificate with an unexpected `CertType`.

    #[error("Unexpected cert type")]

    CertType(tor_cert::CertType),

}

impl Keygen for curve25519::StaticKeypair {

}

impl ItemType for curve25519::StaticKeypair {

}

impl EncodableItem for curve25519::StaticKeypair {

}

impl ItemType for curve25519::PublicKey {

}

impl EncodableItem for curve25519::PublicKey {

}

impl Keygen for ed25519::Keypair {

}

impl ItemType for ed25519::Keypair {

}

impl EncodableItem for ed25519::Keypair {

}

impl ItemType for ed25519::PublicKey {

}

impl EncodableItem for ed25519::PublicKey {

}

impl Keygen for ed25519::ExpandedKeypair {

}

impl ItemType for ed25519::ExpandedKeypair {

}

impl EncodableItem for ed25519::ExpandedKeypair {

}

impl ItemType for crate::EncodedEd25519Cert {

}

impl ItemType for crate::ParsedEd25519Cert {

}

impl EncodableItem for crate::EncodedEd25519Cert {

}