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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
use custom_error::custom_error;
use openidconnect::http::Method;
use openidconnect::reqwest::async_http_client;
use openidconnect::url::{ParseError, Url};
use openidconnect::{
core::CoreTokenType, ExtraTokenFields, HttpRequest, StandardTokenIntrospectionResponse,
};
use reqwest::header::{HeaderMap, ACCEPT, AUTHORIZATION, CONTENT_TYPE};
use serde::{Deserialize, Serialize};
use crate::credentials::{Application, ApplicationError};
custom_error! {
/// Error type for introspection related errors.
pub IntrospectionError
RequestFailed{source: openidconnect::reqwest::Error<reqwest::Error>} = "the introspection request did fail: {source}",
PayloadSerialization = "could not correctly serialize introspection payload",
JWTProfile{source: ApplicationError} = "could not create signed jwt key: {source}",
ParseUrl{source: ParseError} = "could not parse url: {source}",
ParseResponse{source: serde_json::Error} = "could not parse introspection response: {source}",
}
/// Introspection response information that is returned by the ZITADEL
/// introspection endpoint. Introspection returns the
/// [specified information](https://zitadel.com/docs/apis/openidoauth/endpoints#introspect-response)
/// by default and [additional claims](https://zitadel.com/docs/apis/openidoauth/claims)
/// if requested by scope.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ZitadelIntrospectionExtraTokenFields {
pub name: Option<String>,
pub given_name: Option<String>,
pub family_name: Option<String>,
pub preferred_username: Option<String>,
pub email: Option<String>,
pub email_verified: Option<bool>,
pub locale: Option<String>,
}
impl ExtraTokenFields for ZitadelIntrospectionExtraTokenFields {}
/// Type alias for the ZITADEL introspection response.
pub type ZitadelIntrospectionResponse =
StandardTokenIntrospectionResponse<ZitadelIntrospectionExtraTokenFields, CoreTokenType>;
/// Definition of the authentication scheme against the authority (or issuer). This authentication
/// is required when performing actions like introspection against any ZITADEL instance.
///
/// As an example, when a web API wants to check an incoming user token, it authenticates itself
/// against ZITADEL with basic credentials (client id/secret) and then checks if the presented
/// user token is valid.
///
/// [JWTProfile](https://www.rfc-editor.org/rfc/rfc9068) is the recommended way to authenticate
/// against ZITADEL as it provides better security and faster response times.
#[derive(Debug, Clone)]
pub enum AuthorityAuthentication {
/// Basic authentication uses client id/secret as HTTP Basic authentication.
Basic {
client_id: String,
client_secret: String,
},
/// JWTProfile uses an [Application] with a private RSA key to create and sign
/// a JWT token. This token authenticates the application against ZITADEL.
/// This is the recommended way since it provides better security and faster responses.
JWTProfile { application: Application },
}
fn headers(auth: &AuthorityAuthentication) -> HeaderMap {
let mut headers = HeaderMap::new();
headers.append(ACCEPT, "application/json".parse().unwrap());
headers.append(
CONTENT_TYPE,
"application/x-www-form-urlencoded".parse().unwrap(),
);
match auth {
AuthorityAuthentication::Basic {
client_id,
client_secret,
} => {
headers.append(
AUTHORIZATION,
format!(
"Basic {}",
base64::encode(&format!("{}:{}", client_id, client_secret))
)
.parse()
.unwrap(),
);
headers
}
AuthorityAuthentication::JWTProfile { .. } => headers,
}
}
fn payload(
authority: &str,
auth: &AuthorityAuthentication,
token: &str,
) -> Result<String, IntrospectionError> {
match auth {
AuthorityAuthentication::Basic { .. } => serde_urlencoded::to_string(&[("token", token)])
.map_err(|_| IntrospectionError::PayloadSerialization),
AuthorityAuthentication::JWTProfile { application } => {
let jwt = application
.create_signed_jwt(authority)
.map_err(|source| IntrospectionError::JWTProfile { source })?;
serde_urlencoded::to_string(&[
(
"client_assertion_type",
"urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
),
("client_assertion", &jwt),
("token", token),
])
.map_err(|_| IntrospectionError::PayloadSerialization)
}
}
}
/// Perform an [OAuth 2.0 Token Introspection](https://www.rfc-editor.org/rfc/rfc7662)
/// against a given ZITADEL authority (instance). The function does not interpret the result
/// of the call but only returns the introspection result.
///
/// ### Errors
///
/// The introspection may fail if:
/// - The introspection call fails (bad request, unauthorized, other http errors)
/// - The response of the introspection could not be parsed
///
/// ### Example
///
/// #### Introspect the Personal Access Token of the Library Test ZITADEL Instance:
///
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>>{
/// # use zitadel::oidc::discovery::discover;
/// # use zitadel::oidc::introspection::{AuthorityAuthentication, introspect};
/// let auth = AuthorityAuthentication::Basic {
/// client_id: "194339055499018497@zitadel_rust_test".to_string(),
/// client_secret: "Ip56oGzxKL1rJ8JaleUVKL7qUlpZ1tqHQYRSd6JE1mTlTJ3pDkDzoObHdZsOg88B".to_string(),
/// };
/// let authority = "https://zitadel-libraries-l8boqa.zitadel.cloud";
/// let token = "dEnGhIFs3VnqcQU5D2zRSeiarB1nwH6goIKY0J8MWZbsnWcTuu1C59lW9DgCq1y096GYdXA";
/// let metadata = discover(authority).await?;
///
/// let result = introspect(
/// metadata.additional_metadata().introspection_endpoint.as_ref().unwrap(),
/// authority,
/// &auth,
/// token,
/// ).await?;
///
/// println!("{:?}", result);
/// # Ok(())
/// # }
/// ```
pub async fn introspect(
introspection_uri: &str,
authority: &str,
authentication: &AuthorityAuthentication,
token: &str,
) -> Result<ZitadelIntrospectionResponse, IntrospectionError> {
let response = async_http_client(HttpRequest {
url: Url::parse(introspection_uri)
.map_err(|source| IntrospectionError::ParseUrl { source })?,
method: Method::POST,
headers: headers(authentication),
body: payload(authority, authentication, token)?.into_bytes(),
})
.await
.map_err(|source| IntrospectionError::RequestFailed { source })?;
serde_json::from_slice(response.body.as_slice())
.map_err(|source| IntrospectionError::ParseResponse { source })
}
#[cfg(test)]
mod tests {
#![allow(clippy::all)]
use crate::oidc::discovery::discover;
use openidconnect::TokenIntrospectionResponse;
use super::*;
const ZITADEL_URL: &str = "https://zitadel-libraries-l8boqa.zitadel.cloud";
const PERSONAL_ACCESS_TOKEN: &str =
"dEnGhIFs3VnqcQU5D2zRSeiarB1nwH6goIKY0J8MWZbsnWcTuu1C59lW9DgCq1y096GYdXA";
#[tokio::test]
async fn introspect_fails_with_invalid_url() {
let result = introspect(
"foobar",
"foobar",
&AuthorityAuthentication::Basic {
client_id: "".to_string(),
client_secret: "".to_string(),
},
"token",
)
.await;
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
IntrospectionError::ParseUrl { .. }
));
}
#[tokio::test]
async fn introspect_fails_with_invalid_endpoint() {
let meta = discover(ZITADEL_URL).await.unwrap();
let result = introspect(
&meta.token_endpoint().unwrap().to_string(),
ZITADEL_URL,
&AuthorityAuthentication::Basic {
client_id: "".to_string(),
client_secret: "".to_string(),
},
"token",
)
.await;
assert!(result.is_err());
}
#[tokio::test]
async fn introspect_succeeds() {
let meta = discover(ZITADEL_URL).await.unwrap();
let result = introspect(
&meta
.additional_metadata()
.introspection_endpoint
.as_ref()
.unwrap()
.to_string(),
ZITADEL_URL,
&AuthorityAuthentication::Basic {
client_id: "194339055499018497@zitadel_rust_test".to_string(),
client_secret: "Ip56oGzxKL1rJ8JaleUVKL7qUlpZ1tqHQYRSd6JE1mTlTJ3pDkDzoObHdZsOg88B"
.to_string(),
},
PERSONAL_ACCESS_TOKEN,
)
.await
.unwrap();
assert!(result.active());
}
}