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
// 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(),
}
}
}
/// For know thir implementation refers to this: https://www.rfc-editor.org/rfc/rfc8037.html
/// But later could be changed 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.
pub crv: EllipticCurveTypes,
/// The "x" parameter contains the base64url encoded public key
pub x: String,
/// The "d" parameter contains the base64url encoded private key
#[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()
}
}