dfns-sdk-rust 0.2.0

Dfns API SDK for Rust
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
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
// Code generated by rust-sdk-generator. DO NOT EDIT.

#[allow(unused_imports)]
use super::types::*;

/// Delegated client for keys operations. Signed operations are split into
/// init/complete pairs so the challenge can be signed on the user side.
#[derive(Clone)]
pub struct DelegatedKeysClient {
    client: crate::client::Client,
}

impl DelegatedKeysClient {
    pub fn new(client: crate::client::Client) -> Self {
        DelegatedKeysClient { client }
    }

    /// Retrieve all keys registered for your organization.
    pub async fn list_keys(
        &self,
        query: Option<ListKeysQuery>,
    ) -> Result<ListKeysResponse, crate::error::Error> {
        let mut path = String::from("/keys");
        if let Some(query) = &query {
            let mut q: Vec<String> = Vec::new();
            if let Some(v) = &query.limit {
                q.push(format!("limit={}", urlencoding::encode(&v.to_string())));
            }
            if let Some(v) = &query.pagination_token {
                q.push(format!(
                    "paginationToken={}",
                    urlencoding::encode(&v.to_string())
                ));
            }
            if let Some(v) = &query.owner {
                q.push(format!("owner={}", urlencoding::encode(&v.to_string())));
            }
            if !q.is_empty() {
                path.push('?');
                path.push_str(&q.join("&"));
            }
        }
        self.client
            .request::<ListKeysResponse>(reqwest::Method::GET, &path, None, false)
            .await
    }

    /// Starts delegated signing for createKey: returns the challenge to sign.
    /// Pass the signed assertion to create_key_complete with the same arguments.
    pub async fn create_key_init(
        &self,
        body: CreateKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = String::from("/keys");
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for createKey: submits the signed challenge
    /// and issues the request.
    pub async fn create_key_complete(
        &self,
        body: CreateKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<CreateKeyResponse, crate::error::Error> {
        let path = String::from("/keys");
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<CreateKeyResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// Starts delegated signing for delegateKey: returns the challenge to sign.
    /// Pass the signed assertion to delegate_key_complete with the same arguments.
    pub async fn delegate_key_init(
        &self,
        key_id: String,
        body: DelegateKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}/delegate", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for delegateKey: submits the signed challenge
    /// and issues the request.
    pub async fn delegate_key_complete(
        &self,
        key_id: String,
        body: DelegateKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<DelegateKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}/delegate", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<DelegateKeyResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// Retrieves a key information by its ID.
    pub async fn get_key(&self, key_id: String) -> Result<GetKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}", urlencoding::encode(&key_id));
        self.client
            .request::<GetKeyResponse>(reqwest::Method::GET, &path, None, false)
            .await
    }

    /// Starts delegated signing for updateKey: returns the challenge to sign.
    /// Pass the signed assertion to update_key_complete with the same arguments.
    pub async fn update_key_init(
        &self,
        key_id: String,
        body: UpdateKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::PUT, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for updateKey: submits the signed challenge
    /// and issues the request.
    pub async fn update_key_complete(
        &self,
        key_id: String,
        body: UpdateKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<UpdateKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<UpdateKeyResponse>(
                reqwest::Method::PUT,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// Starts delegated signing for deleteKey: returns the challenge to sign.
    /// Pass the signed assertion to delete_key_complete with the same arguments.
    pub async fn delete_key_init(
        &self,
        key_id: String,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}", urlencoding::encode(&key_id));
        self.client
            .create_user_action_challenge(reqwest::Method::DELETE, &path, None)
            .await
    }

    /// Finishes delegated signing for deleteKey: submits the signed challenge
    /// and issues the request.
    pub async fn delete_key_complete(
        &self,
        key_id: String,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<DeleteKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}", urlencoding::encode(&key_id));
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<DeleteKeyResponse>(
                reqwest::Method::DELETE,
                &path,
                None,
                &user_action,
            )
            .await
    }

    /// Starts delegated signing for deriveKey: returns the challenge to sign.
    /// Pass the signed assertion to derive_key_complete with the same arguments.
    pub async fn derive_key_init(
        &self,
        key_id: String,
        body: DeriveKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}/derive", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for deriveKey: submits the signed challenge
    /// and issues the request.
    pub async fn derive_key_complete(
        &self,
        key_id: String,
        body: DeriveKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<DeriveKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}/derive", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<DeriveKeyResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// Starts delegated signing for exportKey: returns the challenge to sign.
    /// Pass the signed assertion to export_key_complete with the same arguments.
    pub async fn export_key_init(
        &self,
        key_id: String,
        body: ExportKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}/export", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for exportKey: submits the signed challenge
    /// and issues the request.
    pub async fn export_key_complete(
        &self,
        key_id: String,
        body: ExportKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<ExportKeyResponse, crate::error::Error> {
        let path = format!("/keys/{}/export", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<ExportKeyResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// List all signature requests for a key.
    pub async fn list_signatures(
        &self,
        key_id: String,
        query: Option<ListSignaturesQuery>,
    ) -> Result<ListSignaturesResponse, crate::error::Error> {
        let mut path = format!("/keys/{}/signatures", urlencoding::encode(&key_id));
        if let Some(query) = &query {
            let mut q: Vec<String> = Vec::new();
            if let Some(v) = &query.limit {
                q.push(format!("limit={}", urlencoding::encode(&v.to_string())));
            }
            if let Some(v) = &query.pagination_token {
                q.push(format!(
                    "paginationToken={}",
                    urlencoding::encode(&v.to_string())
                ));
            }
            if !q.is_empty() {
                path.push('?');
                path.push_str(&q.join("&"));
            }
        }
        self.client
            .request::<ListSignaturesResponse>(reqwest::Method::GET, &path, None, false)
            .await
    }

    /// Starts delegated signing for generateSignature: returns the challenge to sign.
    /// Pass the signed assertion to generate_signature_complete with the same arguments.
    pub async fn generate_signature_init(
        &self,
        key_id: String,
        body: GenerateSignatureRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = format!("/keys/{}/signatures", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for generateSignature: submits the signed challenge
    /// and issues the request.
    pub async fn generate_signature_complete(
        &self,
        key_id: String,
        body: GenerateSignatureRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<GenerateSignatureResponse, crate::error::Error> {
        let path = format!("/keys/{}/signatures", urlencoding::encode(&key_id));
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<GenerateSignatureResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }

    /// Retrieve a signature request details.
    pub async fn get_signature(
        &self,
        key_id: String,
        signature_id: String,
    ) -> Result<GetSignatureResponse, crate::error::Error> {
        let path = format!(
            "/keys/{}/signatures/{}",
            urlencoding::encode(&key_id),
            urlencoding::encode(&signature_id)
        );
        self.client
            .request::<GetSignatureResponse>(reqwest::Method::GET, &path, None, false)
            .await
    }

    /// Starts delegated signing for importKey: returns the challenge to sign.
    /// Pass the signed assertion to import_key_complete with the same arguments.
    pub async fn import_key_init(
        &self,
        body: ImportKeyRequest,
    ) -> Result<crate::signer::UserActionChallenge, crate::error::Error> {
        let path = String::from("/keys/import");
        let body = serde_json::to_value(&body)?;
        self.client
            .create_user_action_challenge(reqwest::Method::POST, &path, Some(&body))
            .await
    }

    /// Finishes delegated signing for importKey: submits the signed challenge
    /// and issues the request.
    pub async fn import_key_complete(
        &self,
        body: ImportKeyRequest,
        challenge_identifier: String,
        assertion: crate::signer::CredentialAssertion,
    ) -> Result<ImportKeyResponse, crate::error::Error> {
        let path = String::from("/keys/import");
        let body = serde_json::to_value(&body)?;
        let user_action = self
            .client
            .complete_user_action_signing(challenge_identifier, &assertion)
            .await?;
        self.client
            .request_with_user_action::<ImportKeyResponse>(
                reqwest::Method::POST,
                &path,
                Some(&body),
                &user_action,
            )
            .await
    }
}