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
//! Implements Swagger UI [oauth configuration](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/oauth2.md) options.
use serde::Serialize;
use std::collections::HashMap;
/// Object used to alter Swagger UI oauth settings.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .client_id("client-id")
/// .use_pkce_with_authorization_code_grant(true);
/// ```
#[non_exhaustive]
#[derive(Default, Clone, Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct OauthConfig {
/// oauth client_id the Swagger UI is using for auth flow.
#[serde(skip_serializing_if = "Option::is_none")]
pub client_id: Option<String>,
/// oauth client_secret the Swagger UI is using for auth flow.
#[serde(skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
/// oauth realm the Swagger UI is using for auth flow. realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
#[serde(skip_serializing_if = "Option::is_none")]
pub realm: Option<String>,
/// oauth app_name the Swagger UI is using for auth flow. application name, displayed in authorization popup.
#[serde(skip_serializing_if = "Option::is_none")]
pub app_name: Option<String>,
/// oauth scope_separator the Swagger UI is using for auth flow.
/// scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20).
#[serde(skip_serializing_if = "Option::is_none")]
pub scope_separator: Option<String>,
/// oauth scopes the Swagger UI is using for auth flow.[`Vec<String>`] of initially selected oauth scopes, default is empty.
#[serde(skip_serializing_if = "Option::is_none")]
pub scopes: Option<Vec<String>>,
/// oauth additional_query_string_params the Swagger UI is using for auth flow.
/// [`HashMap<String, String>`] of additional query parameters added to authorizationUrl and tokenUrl
#[serde(skip_serializing_if = "Option::is_none")]
pub additional_query_string_params: Option<HashMap<String, String>>,
/// oauth use_basic_authentication_with_access_code_grant the Swagger UI is using for auth flow.
/// Only activated for the accessCode flow. During the authorization_code request to the tokenUrl,
/// pass the [Client Password](https://tools.ietf.org/html/rfc6749#section-2.3.1) using the HTTP Basic Authentication scheme
/// (Authorization header with Basic base64encode(client_id + client_secret)).
/// The default is false
#[serde(skip_serializing_if = "Option::is_none")]
pub use_basic_authentication_with_access_code_grant: Option<bool>,
/// oauth use_pkce_with_authorization_code_grant the Swagger UI is using for auth flow.
/// Only applies to authorizatonCode flows. [Proof Key for Code Exchange](https://tools.ietf.org/html/rfc7636)
/// brings enhanced security for OAuth public clients.The default is false
#[serde(skip_serializing_if = "Option::is_none")]
pub use_pkce_with_authorization_code_grant: Option<bool>,
}
impl OauthConfig {
/// Create a new [`Config`] for oauth auth flow.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new();
/// ```
pub fn new() -> Self {
Self {
..Default::default()
}
}
/// Add client_id into [`Config`].Method takes one argument which exposes the client_id to the user.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .client_id("client-id");
/// ```
pub fn client_id(mut self, client_id: &str) -> Self {
self.client_id = Some(String::from(client_id));
self
}
/// Add client_secret into [`Config`].
/// Method takes one argument which exposes the client_secret to the user.
/// 🚨 Never use this parameter in your production environment.
/// It exposes crucial security information. This feature is intended for dev/test environments only. 🚨
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .client_secret("client-secret");
/// ```
pub fn client_secret(mut self, client_secret: &str) -> Self {
self.client_secret = Some(String::from(client_secret));
self
}
/// Add realm into [`Config`].Method takes one argument which exposes the realm to the user.realm query parameter (for oauth1) added to authorizationUrl and tokenUrl.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .realm("realm");
/// ```
pub fn realm(mut self, realm: &str) -> Self {
self.realm = Some(String::from(realm));
self
}
/// Add app_name into [`Config`].Method takes one argument which exposes the app_name to the user.application name, displayed in authorization popup.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .app_name("app-name");
/// ```
pub fn app_name(mut self, app_name: &str) -> Self {
self.app_name = Some(String::from(app_name));
self
}
/// Add scope_separator into [`Config`].
/// Method takes one argument which exposes the scope_separator to the user.
/// scope separator for passing scopes, encoded before calling, default value is a space (encoded value %20).
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .scope_separator(",");
/// ```
pub fn scope_separator(mut self, scope_separator: &str) -> Self {
self.scope_separator = Some(String::from(scope_separator));
self
}
/// Add scopes into [`Config`].
/// Method takes one argument which exposes the scopes to the user.
/// [`Vec<String>`] of initially selected oauth scopes, default is empty.
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .scopes(vec![String::from("openid")]);
/// ```
pub fn scopes(mut self, scopes: Vec<String>) -> Self {
self.scopes = Some(scopes);
self
}
/// Add additional_query_string_params into [`Config`].
/// Method takes one argument which exposes the additional_query_string_params to the user.
/// [`HashMap<String, String>`] of additional query parameters added to authorizationUrl and tokenUrl
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// # use std::collections::HashMap;
/// let config = OauthConfig::new()
/// .additional_query_string_params(HashMap::from([(String::from("a"), String::from("1"))]));
/// ```
pub fn additional_query_string_params(
mut self,
additional_query_string_params: HashMap<String, String>,
) -> Self {
self.additional_query_string_params = Some(additional_query_string_params);
self
}
/// Add use_basic_authentication_with_access_code_grant into [`Config`].
/// Method takes one argument which exposes the use_basic_authentication_with_access_code_grant to the user.
/// Only activated for the accessCode flow. During the authorization_code request to the tokenUrl,
/// pass the [Client Password](https://tools.ietf.org/html/rfc6749#section-2.3.1) using the HTTP Basic Authentication scheme
/// (Authorization header with Basic base64encode(client_id + client_secret)).
/// The default is false
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .use_basic_authentication_with_access_code_grant(true);
/// ```
pub fn use_basic_authentication_with_access_code_grant(
mut self,
use_basic_authentication_with_access_code_grant: bool,
) -> Self {
self.use_basic_authentication_with_access_code_grant =
Some(use_basic_authentication_with_access_code_grant);
self
}
/// Add use_pkce_with_authorization_code_grant into [`Config`].
/// Method takes one argument which exposes the use_pkce_with_authorization_code_grant to the user.
/// Only applies to authorizatonCode flows. [Proof Key for Code Exchange](https://tools.ietf.org/html/rfc7636)
/// brings enhanced security for OAuth public clients.The default is false
/// # Examples
/// ```
/// # use hypers_openapi::swagger_ui::OauthConfig;
/// let config = OauthConfig::new()
/// .use_pkce_with_authorization_code_grant(true);
/// ```
pub fn use_pkce_with_authorization_code_grant(
mut self,
use_pkce_with_authorization_code_grant: bool,
) -> Self {
self.use_pkce_with_authorization_code_grant = Some(use_pkce_with_authorization_code_grant);
self
}
}