//! An error type for [`ArtiNativeKeystore`](crate::ArtiNativeKeystore).

use crate::keystore::fs_utils::FilesystemError;

use crate::raw::RawEntryId;

use crate::{ArtiPathSyntaxError, KeystoreError, UnknownKeyTypeError};

use tor_error::{ErrorKind, HasKind};

use tor_key_forge::{CertType, KeyType, SshKeyAlgorithm};

use std::path::PathBuf;

use std::sync::Arc;

/// An error returned by [`ArtiNativeKeystore`](crate::ArtiNativeKeystore)'s

/// [`Keystore`](crate::Keystore) implementation.

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

pub(crate) enum ArtiNativeKeystoreError {

    /// An error that occurred while accessing the filesystem.

    #[error("{0}")]

    Filesystem(#[from] FilesystemError),

    /// Found a key with an invalid path.

    //

    // TODO: Should we expose the underlying MalformedPathError? The current

    // message "Key has invalid path" is too vague.

    #[error("Key has invalid path: {path}")]

    MalformedPath {

        /// The path of the key.

        path: PathBuf,

        /// The underlying error.

        #[source]

        err: MalformedPathError,

    },

    /// An error due to encountering an unsupported [`KeyType`].

    #[error("{0}")]

    UnknownKeyType(#[from] UnknownKeyTypeError),

    /// Failed to parse an OpenSSH key.

    #[error("Failed to parse OpenSSH with type {key_type:?}")]

    SshKeyParse {

        /// The path of the malformed key.

        path: PathBuf,

        /// The type of key we were trying to fetch.

        key_type: KeyType,

        /// The underlying error.

        #[source]

        err: Arc<ssh_key::Error>,

    },

    /// The OpenSSH key we retrieved is of the wrong type.

    #[error("Unexpected OpenSSH key type: wanted {wanted_key_algo}, found {found_key_algo}")]

    UnexpectedSshKeyType {

        /// The path of the malformed key.

        path: PathBuf,

        /// The algorithm we expected the key to use.

        wanted_key_algo: SshKeyAlgorithm,

        /// The algorithm of the key we got.

        found_key_algo: SshKeyAlgorithm,

    },

    /// Failed to parse an OpenSSH key.

    #[error("Failed to parse cert with type {cert_type:?}")]

    CertParse {

        /// The path of the malformed key.

        path: PathBuf,

        /// The type of cert we were trying to fetch.

        cert_type: CertType,

        /// The underlying error.

        #[source]

        err: tor_bytes::Error,

    },

    /// Encountered a non-path `RawEntryId` variant.

    #[error("Raw entry {:?} not supported in an Arti keystore", _0)]

    UnsupportedRawEntry(RawEntryId),

    /// An internal error.

    #[error("Internal error")]

    Bug(#[from] tor_error::Bug),

}

/// The keystore contained a file whose name syntactically improper

///

/// Keys are supposed to have pathnames consisting of an `ArtiPath`

/// followed by a file extension.

///

/// See also [`KeyPathError`](crate::KeyPathError), which occurs at a higher level.

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

pub(crate) enum MalformedPathError {

    /// Found a key with a non-UTF-8 path.

    #[error("the path is not valid UTF-8")]

    Utf8,

    /// Found a key with no extension.

    #[error("no extension")]

    NoExtension,

    /// The file path is not a valid [`ArtiPath`](crate::ArtiPath).

    #[error("not a valid ArtiPath")]

    InvalidArtiPath(ArtiPathSyntaxError),

}

impl KeystoreError for ArtiNativeKeystoreError {}

impl HasKind for ArtiNativeKeystoreError {

        use ArtiNativeKeystoreError as KE;

            KE::SshKeyParse { .. } | KE::UnexpectedSshKeyType { .. } | KE::CertParse { .. } => {

            }

        }

}

impl From<ArtiNativeKeystoreError> for crate::Error {

}