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
//! Encoding, decoding, signing and verification ([Detached JWS](https://medium.com/gin-and-tonic/implementing-detached-json-web-signature-9ca5665ddcfc)) //! //! Signing and verifying is done through the [`Sign`] and [`Verify`] traits. //! //! # Example with writer: //! ``` //! use openssl::pkey::PKey; //! use openssl::rsa::Rsa; //! use openssl::{hash::MessageDigest}; //! use openssl::{ //! rsa::Padding, //! sign::{Signer, Verifier}, //! }; //! use serde_json::{json, Map, Value}; //! use std::io::{Write}; //! use detached_jws::{SerializeJwsWriter, DeserializeJwsWriter}; //! //! let keypair = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); //! //! let mut signer = Signer::new(MessageDigest::sha256(), &keypair).unwrap(); //! signer.set_rsa_padding(Padding::PKCS1_PSS).unwrap(); //! //! let mut header = Map::new(); //! header.insert("custom".to_owned(), json!("custom_value")); //! //! let mut writer = SerializeJwsWriter::new(Vec::new(), //! "PS256".to_owned(), //! header, //! signer).unwrap(); //! writer.write_all(&[0, 1, 2, 3]); //! writer.write_all(&[4, 5, 6]); //! //! let jws = writer.finish().unwrap(); //! //! let mut verifier = Verifier::new(MessageDigest::sha256(), &keypair).unwrap(); //! verifier.set_rsa_padding(Padding::PKCS1_PSS).unwrap(); //! //! let mut writer = DeserializeJwsWriter::new(&jws, //! |h| Some(verifier) //! ).unwrap(); //! writer.write_all(&[0, 1, 2, 3]); //! writer.write_all(&[4, 5, 6]); //! //! let verified_headers = writer.finish().unwrap(); //! //! assert_eq!( //! verified_headers.get("custom").unwrap().as_str().unwrap(), //! "custom_value" //! ); //! ``` //! //! # Simple example: //! ``` //! use openssl::pkey::PKey; //! use openssl::rsa::Rsa; //! use openssl::{hash::MessageDigest}; //! use openssl::{ //! rsa::Padding, //! sign::{Signer, Verifier}, //! }; //! use serde_json::{json, Map, Value}; //! //! let keypair = PKey::from_rsa(Rsa::generate(2048).unwrap()).unwrap(); //! //! let mut signer = Signer::new(MessageDigest::sha256(), &keypair).unwrap(); //! signer.set_rsa_padding(Padding::PKCS1_PSS).unwrap(); //! //! let mut header = Map::new(); //! header.insert("custom".to_owned(), json!("custom_value")); //! //! let payload = vec![0, 1, 2, 3, 4, 5, 6]; //! //! let jws = detached_jws::serialize( //! "PS256".to_owned(), //! header, //! &mut payload.as_slice(), //! signer, //! ) //! .unwrap(); //! //! let mut verifier = Verifier::new(MessageDigest::sha256(), &keypair).unwrap(); //! verifier.set_rsa_padding(Padding::PKCS1_PSS).unwrap(); //! //! let verified_headers = //! detached_jws::deserialize(&jws, &mut payload.as_slice(), verifier).unwrap(); //! //! assert_eq!( //! verified_headers.get("custom").unwrap().as_str().unwrap(), //! "custom_value" //! ); //! ``` pub mod decode; pub mod encode; pub mod openssl; use anyhow::Result; use serde_json::{value::Value, Map}; use std::io::Read; use std::io::Write; pub use crate::decode::{deserialize, deserialize_selector, DeserializeJwsWriter}; pub use crate::encode::{serialize, SerializeJwsWriter}; pub type JwsHeader = Map<String, Value>; /// A signature signer pub trait Sign: Write { fn get_sign(&self) -> Result<Vec<u8>>; fn form_detached_jws( self, algorithm: String, header: JwsHeader, payload: &mut impl Read, ) -> Result<Vec<u8>> where Self: Sized, { serialize(algorithm, header, payload, self) } } /// A signature verifier pub trait Verify: Write { fn verify(&self, signature: &[u8]) -> Result<bool>; fn verify_jws_detached( self, jws: &impl AsRef<[u8]>, payload: &mut impl Read, ) -> Result<JwsHeader> where Self: Sized, { deserialize(jws, payload, self) } }