ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

【每周一库】- JWT的Rust实现

2021-05-09 07:05:28  阅读:354  来源: 互联网

标签:Default JWT secret 一库 token let 密钥 Validation Rust


sonwebtoken

Rust实现的JSON Web Token库,用于安全身份验证。

安装

将以下内容加入 Cargo.toml:

jsonwebtoken = "7"
serde = {version = "1.0", features = ["derive"] }

需要Rust 1.39及以上版本

算法

这个库目前支持以下算法:

  • HS256
  • HS384
  • HS512
  • RS256
  • RS384
  • RS512
  • PS256
  • PS384
  • PS512
  • ES256
  • ES384

如何使用

引用与结构型:

use serde::{Serialize, Deserialize};
use jsonwebtoken::{encode, decode, Header, Algorithm, Validation, EncodingKey, DecodingKey};

/// 我们的声言结构型, 需要由`Serialize` 或 `Deserialize`派生
#[derive(Debug, Serialize, Deserialize)]
struct Claims {
   sub: String,
   company: String,
   exp: usize,
}

声言

声言中可被验证的字段。

#[derive(Debug, Serialize, Deserialize)]
struct Claims {
   aud: String,         // 可选。听众
   exp: usize,          // 必须。(validate_exp 在验证中默认为真值)。截止时间 (UTC 时间戳)
   iat: usize,          // 可选。发布时间 (UTC 时间戳)
   iss: String,         // 可选。发布者
   nbf: usize,          // 可选。不早于 (UTC 时间戳)
   sub: String,         // 可选。标题 (令牌指向的人)
}

标头

默认算法是HS256,它使用共享机密。

let token = encode(&Header::default(), &my_claims, &EncodingKey::from_secret("secret".as_ref()))?;

自定义标头和更改算法

支持RFC中的所有参数,但默认的标头只有typalg这两个集。在你需要设置kid参数或者更改算法时可以这样做:

let mut header = Header::new(Algorithm::HS512);
header.kid = Some("blabla".to_owned());
let token = encode(&header, &my_claims, &EncodingKey::from_secret("secret".as_ref()))?;

编码

// HS256
let token = encode(&Header::default(), &my_claims, &EncodingKey::from_secret("secret".as_ref()))?;
// RSA
let token = encode(&Header::new(Algorithm::RS256), &my_claims, &EncodingKey::from_rsa_pem(include_bytes!("privkey.pem"))?)?;

将一个JWT进行编码时需要以下3个参数:

  • 一个标头: Header 结构型
  • 某些声言: 你定义的结构型
  • 一个key或secret

当使用HS256,HS2384或HS512时,密钥始终是共享机密,如上例所示。使用RSA / EC时,密钥应始终是PEM或DER格式的私钥内容。如果密钥是PEM格式,则最好以lazy_static或类似的方式生成一次EncodingKey,然后重复使用,以实现更好的性能。

解码

// `token` 是一个有两个参数的结构型: `标头` 和 `声言` (`声言` 为你自己定义的结构型)
let token = decode::<Claims>(&token, &DecodingKey::from_secret("secret".as_ref()), &Validation::default())?;

解码 会因以下原因产生错误:

  • 令牌或它对应的签名是无效的
  • 令牌是无效的base64字符串
  • 至少有一个预定的声言验证失败

与编码一样,使用HS256,HS2384或HS512时,密钥始终像上面的示例一样是共享机密。使用RSA / EC时,密钥应始终是PEM或DER格式的公共密钥的内容。在某些情况下,例如,如果你不知道所使用的算法或需要获取kid,则可以选择仅解码标头:

let header = decode_header(&token)?;

这不会执行任何签名验证或验证令牌声明。你还可以使用base64格式的RSA密钥的公钥组件对令牌进行解码。主要用例为JWK,其中公钥采用JSON格式,如下所示:

{
  "kty":"RSA",
  "e":"AQAB",
  "kid":"6a7a119f-0876-4f7e-8d0f-bf3ea1391dd8",
  "n":"yRE6rHuNR0QbHO3H3Kt2pOKGVhQqGZXInOduQNxXzuKlvQTLUTv4l4sggh5_CYYi_cvI-SXVT9kPWSKXxJXBXd_4LkvcPuUakBoAkfh-eiFVMh2VrUyWyj3MFl0HTVF9KwRXLAcwkREiS3npThHRyIxuy0ZMeZfxVL5arMhw1SRELB8HoGfG_AtH89BIE9jDBHZ9dLelK9a184zAf8LwoPLxvJb3Il5nncqPcSfKDDodMFBIMc4lQzDKL5gvmiXLXB1AGLm8KBjfE8s3L5xqi-yUod-j8MtvIj812dkS4QMiRVN_by2h3ZY8LYVGrqZXZTcgn2ujn8uKjXLZVD5TdQ"
}
// `token` 是一个有两个参数的结构型: `标头` 和 `声言` (`声言` 为你自己定义的结构型)
let token = decode::<Claims>(&token, &DecodingKey::from_rsa_components(jwk["n"], jwk["e"]), &Validation::new(Algorithm::RS256))?;

如果密钥是PEM格式,则最好以lazy_static或类似的方式生成一次DecodingKey,并且复用,这样会优化性能。

将 SEC1 私钥转换为 PKCS8

jsonwebtoken目前仅支持私有EC密钥的PKCS8格式。如果你的密钥顶部带有BEGIN EC PRIVATE KEY,则为SEC1类型,可以将其转换为PKCS8,如下所示:

openssl pkcs8 -topk8 -nocrypt -in sec1.pem -out pkcs8.pem

验证

该库自动验证exp声明,并验证nbf(如果存在)。你还可以验证subissaud,但是需要在Validation结构型中设置期望值。时钟偏差会让验证时间字段比较麻烦,你可以通过设置leeway字段为iatexpnbf验证添加一些余地。最后需要注意的一点是,如果不使用HS256,则需要设置此令牌允许的算法。

#[derive(Debug, Clone, PartialEq)]
struct Validation {
   pub leeway: u64,                    // Default: 0
   pub validate_exp: bool,             // Default: true
   pub validate_nbf: bool,             // Default: false
   pub aud: Option<HashSet<String>>,   // Default: None
   pub iss: Option<String>,            // Default: None
   pub sub: Option<String>,            // Default: None
   pub algorithms: Vec<Algorithm>,     // Default: vec![Algorithm::HS256]
}
use jsonwebtoken::{Validation, Algorithm};

// 默认验证:唯一允许的算法是HS256
let validation = Validation::default();
// 快速设置验证的方法,只需更改算法即可
let validation = Validation::new(Algorithm::HS512);
// 为exp和nbf检查添加一些余地(以秒为单位)
let mut validation = Validation {leeway: 60, ..Default::default()};
// 检查发布者
let mut validation = Validation {iss: Some("issuer".to_string()), ..Default::default()};
// 设置听众
let mut validation = Validation::default();
validation.set_audience(&"Me"); // string
validation.set_audience(&["Me", "You"]); // array of strings



标签:Default,JWT,secret,一库,token,let,密钥,Validation,Rust
来源: https://blog.51cto.com/u_15127605/2762835

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有