azure_identity/device_code_flow/mod.rs
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
//! Authorize using the device authorization grant flow
//!
//! This flow allows users to sign in to input-constrained devices such as a smart TV, `IoT` device, or printer.
//!
//! You can learn more about this authorization flow [here](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-device-code).
mod device_code_responses;
use azure_core::{
content_type,
error::{Error, ErrorKind},
from_json, headers, sleep, HttpClient, Method, Request, Response, Url,
};
pub use device_code_responses::*;
use futures::stream::unfold;
use serde::Deserialize;
use std::{borrow::Cow, pin::Pin, sync::Arc, time::Duration};
use url::form_urlencoded;
/// Start the device authorization grant flow.
/// The user has only 15 minutes to sign in (the usual value for `expires_in`).
pub async fn start<'a, 'b, T>(
http_client: Arc<dyn HttpClient>,
tenant_id: T,
client_id: &str,
scopes: &'b [&'b str],
) -> azure_core::Result<DeviceCodePhaseOneResponse<'a>>
where
T: Into<Cow<'a, str>>,
{
let tenant_id = tenant_id.into();
let url = &format!("https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/devicecode");
let encoded = form_urlencoded::Serializer::new(String::new())
.append_pair("client_id", client_id)
.append_pair("scope", &scopes.join(" "))
.finish();
let rsp = post_form(http_client.clone(), url, encoded).await?;
let (rsp_status, rsp_headers, rsp_body) = rsp.deconstruct();
let rsp_body = rsp_body.collect().await?;
if !rsp_status.is_success() {
return Err(
ErrorKind::http_response_from_parts(rsp_status, &rsp_headers, &rsp_body).into_error(),
);
}
let device_code_response: DeviceCodePhaseOneResponse = from_json(&rsp_body)?;
// we need to capture some variables that will be useful in
// the second phase (the client, the tenant_id and the client_id)
Ok(DeviceCodePhaseOneResponse {
device_code: device_code_response.device_code,
user_code: device_code_response.user_code,
verification_uri: device_code_response.verification_uri,
expires_in: device_code_response.expires_in,
interval: device_code_response.interval,
message: device_code_response.message,
http_client: Some(http_client),
tenant_id,
client_id: client_id.to_string(),
})
}
/// Contains the required information to allow a user to sign in.
#[derive(Debug, Clone, Deserialize)]
pub struct DeviceCodePhaseOneResponse<'a> {
device_code: String,
user_code: String,
verification_uri: String,
expires_in: u64,
interval: u64,
message: String,
// The skipped fields below do not come from the Azure answer.
// They will be added manually after deserialization
#[serde(skip)]
http_client: Option<Arc<dyn HttpClient>>,
#[serde(skip)]
tenant_id: Cow<'a, str>,
// We store the ClientId as string instead of the original type, because it
// does not implement Default, and it's in another crate
#[serde(skip)]
client_id: String,
}
impl<'a> DeviceCodePhaseOneResponse<'a> {
/// The message containing human readable instructions for the user.
pub fn message(&self) -> &str {
&self.message
}
/// Polls the token endpoint while the user signs in.
/// This will continue until either success or error is returned.
pub fn stream(
&self,
) -> Pin<Box<impl futures::Stream<Item = azure_core::Result<DeviceCodeAuthorization>> + '_>>
{
#[derive(Debug, Clone, PartialEq, Eq)]
enum NextState {
Continue,
Finish,
}
Box::pin(unfold(
NextState::Continue,
move |state: NextState| async move {
match state {
NextState::Continue => {
let url = &format!(
"https://login.microsoftonline.com/{}/oauth2/v2.0/token",
self.tenant_id,
);
// Throttle down as specified by Azure. This could be
// smarter: we could calculate the elapsed time since the
// last poll and wait only the delta.
sleep(Duration::from_secs(self.interval)).await;
let encoded = form_urlencoded::Serializer::new(String::new())
.append_pair(
"grant_type",
"urn:ietf:params:oauth:grant-type:device_code",
)
.append_pair("client_id", self.client_id.as_str())
.append_pair("device_code", &self.device_code)
.finish();
let http_client = self.http_client.clone().unwrap();
match post_form(http_client.clone(), url, encoded).await {
Ok(rsp) => {
let rsp_status = rsp.status();
let rsp_body = match rsp.into_body().collect().await {
Ok(b) => b,
Err(e) => return Some((Err(e), NextState::Finish)),
};
if rsp_status.is_success() {
match from_json::<_, DeviceCodeAuthorization>(&rsp_body) {
Ok(authorization) => {
Some((Ok(authorization), NextState::Finish))
}
Err(error) => Some((Err(error), NextState::Finish)),
}
} else {
match from_json::<_, DeviceCodeErrorResponse>(&rsp_body) {
Ok(error_rsp) => {
let next_state =
if error_rsp.error == "authorization_pending" {
NextState::Continue
} else {
NextState::Finish
};
Some((
Err(Error::new(ErrorKind::Credential, error_rsp)),
next_state,
))
}
Err(error) => Some((Err(error), NextState::Finish)),
}
}
}
Err(error) => Some((Err(error), NextState::Finish)),
}
}
NextState::Finish => None,
}
},
))
}
}
async fn post_form(
http_client: Arc<dyn HttpClient>,
url: &str,
form_body: String,
) -> azure_core::Result<Response> {
let url = Url::parse(url)?;
let mut req = Request::new(url, Method::Post);
req.insert_header(
headers::CONTENT_TYPE,
content_type::APPLICATION_X_WWW_FORM_URLENCODED,
);
req.set_body(form_body);
http_client.execute_request(&req).await
}
#[cfg(test)]
mod tests {
use super::*;
fn require_send<T: Send>(_t: T) {}
#[test]
fn ensure_that_start_is_send() {
require_send(start(
azure_core::new_http_client(),
"UNUSED",
"UNUSED",
&[],
));
}
}