Make family public (#351)

* Made algorithm family public

* made family public

* Added src doc for alorightms on family

Author: brymko

src/algorithms.rs

@@ -5,13 +5,35 @@ use serde::{Deserialize, Serialize};
 use crate::errors::{Error, ErrorKind, Result};
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, Serialize, Deserialize)]
-pub(crate) enum AlgorithmFamily {
+pub enum AlgorithmFamily {
     Hmac,
     Rsa,
     Ec,
     Ed,
 }
 
+impl AlgorithmFamily {
+    /// A list of all possible Algorithms that are part of the family.
+    pub fn algorithms(&self) -> &[Algorithm] {
+        match self {
+            Self::Hmac => &[Algorithm::HS256, Algorithm::HS384, Algorithm::HS512],
+            Self::Rsa => &[
+                Algorithm::RS256,
+                Algorithm::RS384,
+                Algorithm::RS512,
+                Algorithm::PS256,
+                Algorithm::PS384,
+                Algorithm::PS384,
+                Algorithm::PS512,
+            ],
+            Self::Ec => &[Algorithm::ES256, Algorithm::ES384],
+            Self::Ed => &[Algorithm::EdDSA],
+        }
+    }
+}
+
+
+
 /// The algorithms supported for signing/verifying JWTs
 #[allow(clippy::upper_case_acronyms)]
 #[derive(Debug, Default, PartialEq, Eq, Hash, Copy, Clone, Serialize, Deserialize)]

src/decoding.rs

@@ -93,6 +93,11 @@ pub struct DecodingKey {
 }
 
 impl DecodingKey {
+    /// The algorithm family this key is for.
+    pub fn family(&self) -> AlgorithmFamily {
+        self.family
+    }
+    
     /// If you're using HMAC, use this.
     pub fn from_secret(secret: &[u8]) -> Self {
         DecodingKey {

src/encoding.rs

@@ -40,6 +40,11 @@ pub struct EncodingKey {
 }
 
 impl EncodingKey {
+    /// The algorithm family this key is for.
+    pub fn family(&self) -> AlgorithmFamily {
+        self.family
+    }
+    
     /// If you're using a HMAC secret that is not base64, use that.
     pub fn from_secret(secret: &[u8]) -> Self {
         EncodingKey { family: AlgorithmFamily::Hmac, content: secret.to_vec() }