1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
// Copyright 2023 Fondazione LINKS
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use std::fmt;
use serde::{Deserialize, Serialize};
use crate::{jpa::algs::ProofAlgorithm, encoding::base64url_encode};
use super::{types::KeyType, curves::EllipticCurveTypes};
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq, PartialOrd, Ord, Deserialize, Serialize)]
#[serde(untagged)]
pub enum Algorithm {
Proof(ProofAlgorithm),
// These are defined in the JWA rfc
// Signature(SignatureAlgorithm), https://datatracker.ietf.org/doc/html/rfc7518#section-3
// KeyManagement(KeyManagementAlgorithm), https://datatracker.ietf.org/doc/html/rfc7518#section-4
// Encryption(EncryptionAlgorithm), https://datatracker.ietf.org/doc/html/rfc7518#section-5
}
impl fmt::Display for Algorithm {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Algorithm::Proof(proof_algorithm) => write!(f, "{}", proof_algorithm),
}
}
}
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
#[serde(untagged)]
pub enum JwkAlgorithmParameters {
// TODO: to be done
// EllipticCurve(JwkEllipticCurveKeyParameters),
// RSA(JwkRSAKeyParameters),
// OctetKey(JwkOctetKeyParameters),
OctetKeyPair(JwkOctetKeyPairParameters),
}
impl JwkAlgorithmParameters {
pub fn to_public(&self) -> Option<Self> {
match self {
Self::OctetKeyPair(inner) => Some(Self::OctetKeyPair(inner.to_public())),
}
}
pub fn is_public(&self) -> bool {
match self {
Self::OctetKeyPair(value) => value.is_public(),
}
}
pub fn is_private(&self) -> bool {
match self {
Self::OctetKeyPair(value) => value.is_private(),
}
}
}
/// Octect Key Pair representation of BLS keys
///
/// For now using this representation https://www.rfc-editor.org/rfc/rfc8037
///
/// Maybe in future change to [this](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03)
#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
pub struct JwkOctetKeyPairParameters {
pub kty: KeyType,
/// The "crv" (curve) parameter identifies the cryptographic curve used
/// with the key.
///
/// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#curve-parameter-registration)
pub crv: EllipticCurveTypes,
/// Represents the base64url encoded public key
///
/// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#section-2.2.1)
pub x: String, // Public Key
/// The "d" parameter contains the base64url encoded private key
///
/// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#section-2.2.1)
#[serde(skip_serializing_if = "Option::is_none")]
pub d: Option<String>,
}
impl JwkOctetKeyPairParameters {
pub fn new<T: AsRef<[u8]>>(crv: EllipticCurveTypes, x: T, d: Option<T> ) -> Self{
Self{
kty: KeyType::OctetKeyPair,
crv: crv,
x: base64url_encode(x),
d: match d {
Some(d) => Some(base64url_encode(d)),
None => None
}
}
}
/// Returns a clone without private key.
pub fn to_public(&self) -> Self {
Self {
kty: KeyType::OctetKeyPair,
crv: self.crv.clone(),
x: self.x.clone(),
d: None,
}
}
/// Returns `true` if _all_ private key components of the key are unset, `false` otherwise.
pub fn is_public(&self) -> bool {
self.d.is_none()
}
/// Returns `true` if _all_ private key components of the key are set, `false` otherwise.
pub fn is_private(&self) -> bool {
self.d.is_some()
}
}
// /// Octect Key Pair representation of BLS keys
// ///
// /// Barreto-Lynn-Scott Elliptic Curve Key Representations for JOSE and COSE
// /// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03)
// #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
// pub struct JwkOctetKeyPairParameters {
// pub kty: KeyType,
// /// The "crv" (curve) parameter identifies the cryptographic curve used
// /// with the key.
// ///
// /// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#curve-parameter-registration)
// pub crv: EllipticCurveTypes,
// /// Represents the base64url encoded x coordinate of the curve point for the public key
// ///
// /// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#section-2.2.1)
// pub x: String, // Public Key's x-coordinate
// /// Represents the base64url encoded y coordinate of the curve point for the public key
// ///
// /// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#section-2.2.1)
// pub y: String, // Public Key's y-coordinate
// /// The "d" parameter contains the base64url encoded private key
// ///
// /// [More Info](https://datatracker.ietf.org/doc/html/draft-ietf-cose-bls-key-representations-03#section-2.2.1)
// #[serde(skip_serializing_if = "Option::is_none")]
// pub d: Option<String>,
// }
// impl JwkOctetKeyPairParameters {
// pub fn new<T: AsRef<[u8]>>(crv: EllipticCurveTypes, x: T, y: T, d: Option<T> ) -> Self{
// Self{
// kty: KeyType::OctetKeyPair,
// crv: crv,
// x: base64url_encode(x),
// y: base64url_encode(y),
// d: match d {
// Some(d) => Some(base64url_encode(d)),
// None => None
// }
// }
// }
// /// Returns a clone without private key.
// pub fn to_public(&self) -> Self {
// Self {
// kty: KeyType::OctetKeyPair,
// crv: self.crv.clone(),
// x: self.x.clone(),
// y: self.y.clone(),
// d: None,
// }
// }
// /// Returns `true` if _all_ private key components of the key are unset, `false` otherwise.
// pub fn is_public(&self) -> bool {
// self.d.is_none()
// }
// /// Returns `true` if _all_ private key components of the key are set, `false` otherwise.
// pub fn is_private(&self) -> bool {
// self.d.is_some()
// }
// }