Skip to content

Tweak names of device auth params structs as a quick fix for oxide.ts #1303

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 29, 2022
Merged

Tweak names of device auth params structs as a quick fix for oxide.ts #1303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions nexus/src/external_api/device_auth.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ where
}

#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
pub struct DeviceAuthRequestParams {
pub struct DeviceAuthRequest {
pub client_id: Uuid,
}

Expand All @@ -64,7 +64,7 @@ pub struct DeviceAuthRequestParams {
}]
pub async fn device_auth_request(
rqctx: Arc<RequestContext<Arc<ServerContext>>>,
params: TypedBody<DeviceAuthRequestParams>,
params: TypedBody<DeviceAuthRequest>,
) -> Result<Response<Body>, HttpError> {
let apictx = rqctx.context();
let nexus = &apictx.nexus;
Expand Down Expand Up @@ -108,7 +108,7 @@ pub async fn device_auth_request(
}

#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
pub struct DeviceAuthVerifyParams {
pub struct DeviceAuthVerify {
pub user_code: String,
}

Expand All @@ -126,7 +126,7 @@ pub struct DeviceAuthVerifyParams {
}]
pub async fn device_auth_verify(
rqctx: Arc<RequestContext<Arc<ServerContext>>>,
params: Query<DeviceAuthVerifyParams>,
params: Query<DeviceAuthVerify>,
) -> Result<Response<Body>, HttpError> {
// If the user is authenticated, serve the console verification page.
if let Ok(opctx) = OpContext::for_external_api(&rqctx).await {
Expand Down Expand Up @@ -160,7 +160,7 @@ pub async fn device_auth_verify(
}]
pub async fn device_auth_confirm(
rqctx: Arc<RequestContext<Arc<ServerContext>>>,
params: TypedBody<DeviceAuthVerifyParams>,
params: TypedBody<DeviceAuthVerify>,
) -> Result<HttpResponseOk<()>, HttpError> {
let apictx = rqctx.context();
let nexus = &apictx.nexus;
Expand All @@ -177,7 +177,7 @@ pub async fn device_auth_confirm(
}

#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
pub struct DeviceAccessTokenRequestParams {
pub struct DeviceAccessTokenRequest {
pub grant_type: String,
pub device_code: String,
pub client_id: Uuid,
Expand All @@ -202,7 +202,7 @@ pub enum DeviceAccessTokenResponse {
}]
pub async fn device_access_token(
rqctx: Arc<RequestContext<Arc<ServerContext>>>,
params: TypedBody<DeviceAccessTokenRequestParams>,
params: TypedBody<DeviceAccessTokenRequest>,
) -> Result<Response<Body>, HttpError> {
let apictx = rqctx.context();
let nexus = &apictx.nexus;
Expand Down
9 changes: 4 additions & 5 deletions nexus/tests/integration_tests/device_auth.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ use nexus_test_utils::http_testing::{AuthnMode, NexusRequest, RequestBuilder};
use nexus_test_utils::ControlPlaneTestContext;
use nexus_test_utils_macros::nexus_test;
use omicron_nexus::external_api::device_auth::{
DeviceAccessTokenRequestParams, DeviceAuthRequestParams,
DeviceAuthVerifyParams,
DeviceAccessTokenRequest, DeviceAuthRequest, DeviceAuthVerify,
};
use omicron_nexus::external_api::views::{
DeviceAccessTokenGrant, DeviceAccessTokenType, DeviceAuthResponse,
Expand Down Expand Up @@ -36,7 +35,7 @@ async fn test_device_auth_flow(cptestctx: &ControlPlaneTestContext) {
.expect("failed to reject device auth start without client_id");

let client_id = Uuid::new_v4();
let authn_params = DeviceAuthRequestParams { client_id };
let authn_params = DeviceAuthRequest { client_id };

// Using a JSON encoded body fails.
RequestBuilder::new(testctx, Method::POST, "/device/auth")
Expand Down Expand Up @@ -96,7 +95,7 @@ async fn test_device_auth_flow(cptestctx: &ControlPlaneTestContext) {
.body
.starts_with(b"<html>"));

let confirm_params = DeviceAuthVerifyParams { user_code };
let confirm_params = DeviceAuthVerify { user_code };

// Confirmation must be authenticated.
RequestBuilder::new(testctx, Method::POST, "/device/confirm")
Expand All @@ -107,7 +106,7 @@ async fn test_device_auth_flow(cptestctx: &ControlPlaneTestContext) {
.await
.expect("failed to 401 on unauthed confirmation");

let token_params = DeviceAccessTokenRequestParams {
let token_params = DeviceAccessTokenRequest {
grant_type: "urn:ietf:params:oauth:grant-type:device_code".to_string(),
device_code,
client_id,
Expand Down
12 changes: 6 additions & 6 deletions openapi/nexus.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DeviceAuthRequestParams"
"$ref": "#/components/schemas/DeviceAuthRequest"
}
}
},
Expand Down Expand Up @@ -52,7 +52,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceAuthVerifyParams"
"$ref": "#/components/schemas/DeviceAuthVerify"
}
}
},
Expand Down Expand Up @@ -94,7 +94,7 @@
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DeviceAccessTokenRequestParams"
"$ref": "#/components/schemas/DeviceAccessTokenRequest"
}
}
},
Expand Down Expand Up @@ -6273,7 +6273,7 @@
"public_cert"
]
},
"DeviceAccessTokenRequestParams": {
"DeviceAccessTokenRequest": {
"type": "object",
"properties": {
"client_id": {
Expand All @@ -6293,7 +6293,7 @@
"grant_type"
]
},
"DeviceAuthRequestParams": {
"DeviceAuthRequest": {
"type": "object",
"properties": {
"client_id": {
Expand All @@ -6305,7 +6305,7 @@
"client_id"
]
},
"DeviceAuthVerifyParams": {
"DeviceAuthVerify": {
"type": "object",
"properties": {
"user_code": {
Expand Down