-
Notifications
You must be signed in to change notification settings - Fork 299
feat: Add insecure_decode_without_signature_validation #418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -286,3 +286,43 @@ pub fn decode_header(token: &str) -> Result<Header> { | |
let (_, header) = expect_two!(message.rsplitn(2, '.')); | ||
Header::from_encoded(header) | ||
} | ||
|
||
/// Decode a JWT without any signature verification and return its claims. | ||
/// This means that the token is not verified so use with caution. | ||
/// This is useful when you want to extract the claims without verifying the signature. | ||
/// | ||
/// # Arguments | ||
/// | ||
/// * `token` - A string slice that holds the JWT token | ||
/// * `validation` - A [Validation](struct.Validation.html) object that holds the validation options | ||
/// | ||
/// # Example | ||
/// | ||
/// ```rust | ||
/// use jsonwebtoken::{insecure_decode_without_signature_validation, Validation, Algorithm}; | ||
/// use serde::{Deserialize, Serialize}; | ||
/// | ||
/// #[derive(Debug, Serialize, Deserialize)] | ||
/// struct Claims { | ||
/// sub: u32, | ||
/// name: String, | ||
/// iat: u64, | ||
/// exp: u64 | ||
/// } | ||
/// | ||
/// // Example token from jwt.io | ||
/// let token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEyMzQ1Njc4OTAsIm5hbWUiOiJKb2huIERvZSIsImlhdCI6MTUxNjIzOTAyMiwiZXhwIjoyNTE2MjM5MDYwfQ.Yf3kCk-BdkW3DZNao3lwMoU41ujnt86OgewBA-Q2uBw".to_string(); | ||
/// let validation = Validation::new(Algorithm::HS256); | ||
/// let claims = insecure_decode_without_signature_validation::<Claims>(&token, &validation).unwrap(); | ||
/// ``` | ||
pub fn insecure_decode_without_signature_validation<T: DeserializeOwned>( | ||
token: &str, | ||
validation: &Validation, | ||
) -> Result<T> { | ||
let (_, rest) = expect_two!(token.rsplitn(2, '.')); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JWT has 3 parts: Header, Payload, Signature. The existing code refers to them by those names:
It would be good to keep them consistent throughout the file. |
||
let (claims, _) = expect_two!(rest.rsplitn(2, '.')); | ||
let decoded_claims = DecodedJwtPartClaims::from_jwt_part_claims(claims)?; | ||
let claims = decoded_claims.deserialize()?; | ||
validate(decoded_claims.deserialize()?, validation)?; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The function description says "the claims are not validated", but they are. |
||
Ok(claims) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm missing something here. Please ignore if I'm wrong.
The function says it does not do validation and the algorithm can be arbitrary chose, yet, there is a validation param and the validation step. So it's kind of partial validation.
I find it confusing and is not what #401 calls for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah i was not completely sure that was the case as the creator of the issue wanted essentially this API:
``rs
let mut validation = jsonwebtoken::Validation::insecure_without_signature_validation();
let payload = jsonwebtoken::insecure_decode_without_signature_validation::(token, &validation).unwrap();