openauth-plugins 0.0.4

Official OpenAuth plugin modules.
Documentation 
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

use openauth_core::api::OpenApiOperation;
use serde_json::{json, Value};

const TAG: &str = "Device Authorization";

pub fn device_code_operation() -> OpenApiOperation {
    OpenApiOperation::new("deviceCode")
        .description("Create an OAuth 2.0 device authorization request.")
        .tag(TAG)
        .request_body(request_body(json!({
            "type": "object",
            "properties": {
                "client_id": { "type": "string" },
                "scope": { "type": "string" },
            },
            "required": ["client_id"],
        })))
        .response(
            "200",
            response("Device authorization code response.", device_code_schema()),
        )
        .response(
            "400",
            response("OAuth device-flow error response.", error_schema()),
        )
}

pub fn device_token_operation() -> OpenApiOperation {
    OpenApiOperation::new("deviceToken")
        .description("Exchange an approved OAuth 2.0 device code for a bearer token.")
        .tag(TAG)
        .request_body(request_body(json!({
            "type": "object",
            "properties": {
                "grant_type": { "type": "string" },
                "device_code": { "type": "string" },
                "client_id": { "type": "string" },
            },
            "required": ["grant_type", "device_code", "client_id"],
        })))
        .response(
            "200",
            response("OAuth bearer token response.", token_schema()),
        )
        .response(
            "400",
            response("OAuth device-flow error response.", error_schema()),
        )
}

pub fn device_verify_operation() -> OpenApiOperation {
    OpenApiOperation::new("deviceVerify")
        .description("Look up a device authorization request by user code.")
        .tag(TAG)
        .parameter(json!({
            "name": "user_code",
            "in": "query",
            "required": true,
            "schema": { "type": "string" },
        }))
        .response(
            "200",
            response("Device verification response.", verification_schema()),
        )
        .response(
            "400",
            response("OAuth device-flow error response.", error_schema()),
        )
}

pub fn device_decision_operation(operation_id: &str, description: &str) -> OpenApiOperation {
    OpenApiOperation::new(operation_id)
        .description(description)
        .tag(TAG)
        .request_body(request_body(json!({
            "type": "object",
            "properties": {
                "userCode": { "type": "string" },
            },
            "required": ["userCode"],
        })))
        .response(
            "200",
            response("Device authorization decision response.", success_schema()),
        )
        .response(
            "400",
            response("OAuth device-flow error response.", error_schema()),
        )
        .response(
            "401",
            response("OAuth device-flow error response.", error_schema()),
        )
        .response(
            "403",
            response("OAuth device-flow error response.", error_schema()),
        )
}

fn request_body(schema: Value) -> Value {
    json!({
        "required": true,
        "content": {
            "application/json": {
                "schema": schema,
            },
            "application/x-www-form-urlencoded": {
                "schema": schema,
            },
        },
    })
}

fn response(description: &str, schema: Value) -> Value {
    json!({
        "description": description,
        "content": {
            "application/json": {
                "schema": schema,
            },
        },
    })
}

fn device_code_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "device_code": { "type": "string" },
            "user_code": { "type": "string" },
            "verification_uri": { "type": "string" },
            "verification_uri_complete": { "type": "string" },
            "expires_in": { "type": "integer" },
            "interval": { "type": "integer" },
        },
        "required": [
            "device_code",
            "user_code",
            "verification_uri",
            "verification_uri_complete",
            "expires_in",
            "interval"
        ],
    })
}

fn token_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "access_token": { "type": "string" },
            "token_type": { "type": "string" },
            "expires_in": { "type": "integer" },
            "scope": { "type": "string" },
        },
        "required": ["access_token", "token_type", "expires_in", "scope"],
    })
}

fn verification_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "user_code": { "type": "string" },
            "status": { "type": "string" },
        },
        "required": ["user_code", "status"],
    })
}

fn success_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "success": { "type": "boolean" },
        },
        "required": ["success"],
    })
}

fn error_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "error": { "type": "string" },
            "error_description": { "type": "string" },
        },
        "required": ["error", "error_description"],
    })
}