dco3 0.20.1

Async API wrapper for DRACOON in 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

//! This module contains all constants, specifically to address API endpoints and default configuration values.

// constants for `grant_type` parameter
pub const GRANT_TYPE_PASSWORD: &str = "password";
pub const GRANT_TYPE_AUTH_CODE: &str = "authorization_code";
pub const GRANT_TYPE_REFRESH_TOKEN: &str = "refresh_token";
pub const TOKEN_TYPE_HINT_ACCESS: &str = "access_token";

// constants for API urls
// AUTH
pub const DRACOON_TOKEN_URL: &str = "oauth/token";
pub const DRACOON_REDIRECT_URL: &str = "oauth/callback";
pub const DRACOON_TOKEN_REVOKE_URL: &str = "oauth/revoke";
pub const TOKEN_TYPE_HINT_ACCESS_TOKEN: &str = "access_token";
pub const TOKEN_TYPE_HINT_REFRESH_TOKEN: &str = "refresh_token";
pub const MAX_TOKEN_COUNT: u8 = 5;
pub const MIN_TOKEN_COUNT: u8 = 1;

// API
pub const DRACOON_API_PREFIX: &str = "api/v4";

// NODES
pub const NODES_BASE: &str = "nodes";
pub const NODES_MOVE: &str = "move_to";
pub const NODES_COPY: &str = "copy_to";
pub const FILES_BASE: &str = "files";
pub const FILES_FILE_KEY: &str = "user_file_key";
pub const FILES_UPLOAD: &str = "uploads";
pub const FILES_S3_URLS: &str = "s3_urls";
pub const FILES_S3_COMPLETE: &str = "s3";
pub const FOLDERS_BASE: &str = "folders";
pub const NODES_DOWNLOAD_URL: &str = "downloads";
pub const NODES_SEARCH: &str = "search";
pub const MISSING_FILE_KEYS: &str = "missingFileKeys";
pub const FILES_KEYS: &str = "keys";
pub const ROOMS_BASE: &str = "rooms";
pub const ROOMS_CONFIG: &str = "config";
pub const ROOMS_ENCRYPT: &str = "encrypt";
pub const ROOMS_USERS: &str = "users";
pub const ROOMS_GROUPS: &str = "groups";
pub const ROOMS_POLICIES: &str = "policies";
pub const ROOMS_GUEST_USERS: &str = "guest_users";
// note: needed for NFS upload (DRACOON Server)
pub const UPLOADS_BASE: &str = "uploads";

// SHARES
pub const SHARES_BASE: &str = "shares";
pub const SHARES_EMAIL: &str = "email";

// SHARES - UPLOAD
pub const SHARES_UPLOAD: &str = "uploads";

// SHARES - DOWNLOAD
pub const SHARES_DOWNLOAD: &str = "downloads";

// DEFAULTS
pub const DEFAULT_UPLOAD_CHUNK_SIZE: usize = 1024 * 1024 * 32; // 32 MB
pub const DEFAULT_DOWNLOAD_CHUNK_SIZE: usize = 1024 * 1024 * 32; // 32 MB
pub const DEFAULT_UPLOAD_GRANULARITY: usize = 1024; // default upload stream granularity
pub const POLLING_START_DELAY: u64 = 300;
// defines how many keys (users) distributed per file on upload
pub const MISSING_KEYS_BATCH: usize = 50;

// EVENTLOG
pub const EVENTLOG_BASE: &str = "eventlog";
pub const EVENTLOG_EVENTS: &str = "events";
pub const EVENTLOG_OPERATIONS: &str = "operations";
pub const AUDITS_BASE: &str = "audits";
pub const AUDITS_NODES: &str = "nodes";
pub const AUDIT_NODE_INFO: &str = "node_info";

// USER
pub const USER_BASE: &str = "user";
pub const USER_ACCOUNT: &str = "account";
pub const USER_ACCOUNT_KEYPAIR: &str = "keypair";
pub const USER_ACCOUNT_CUSTOMER: &str = "customer";

// GROUPS
pub const GROUPS_BASE: &str = "groups";
pub const GROUPS_USERS: &str = "users";
pub const GROUPS_LAST_ADMIN_ROOMS: &str = "last_admin_rooms";

// USERS
pub const USERS_BASE: &str = "users";
pub const USERS_LAST_ADMIN_ROOMS: &str = "last_admin_rooms";

// PROVISIONING
pub const PROVISIONING_BASE: &str = "provisioning";
pub const PROVISIONING_CUSTOMERS: &str = "customers";
pub const PROVISIONING_CUSTOMER_ATTRIBUTES: &str = "customerAttributes";
pub const PROVISIONING_CUSTOMER_USERS: &str = "users";
pub const PROVISIONING_TOKEN_HEADER: &str = "X-Sds-Service-Token";

// ROLES
pub const ROLES_BASE: &str = "roles";
pub const ROLES_GROUPS: &str = "groups";
pub const ROLES_USERS: &str = "users";

// SETTINGS
pub const SETTINGS_BASE: &str = "settings";
pub const SETTINGS_KEYPAIR: &str = "keypair";

// SYSTEM
pub const SYSTEM_BASE: &str = "system";
pub const SYSTEM_CONFIG_BASE: &str = "config";
pub const SYSTEM_AUTH_BASE: &str = "auth";
pub const SYSTEM_AUTH_OPENID: &str = "openid";
pub const SYSTEM_AUTH_OPENID_IDPS: &str = "idps";
pub const SYSTEM_AUTH_ADS: &str = "ads";

// CONFIG
pub const CONFIG_BASE: &str = "config/info";
pub const CONFIG_GENERAL: &str = "general";
pub const CONFIG_DEFAULTS: &str = "defaults";
pub const CONFIG_INFRASTRUCTURE: &str = "infrastructure";
pub const CONFIG_ALGORITHMS: &str = "algorithms";
pub const CONFIG_POLICIES: &str = "policies";
pub const CONFIG_PASSWORD_POLICIES: &str = "passwords";
pub const CONFIG_PRODUCT_PACKAGES: &str = "product_packages";
pub const CONFIG_S3_TAGS: &str = "s3_tags";
pub const CONFIG_PRODUCT_PACKAGES_CURRENT: &str = "current";
pub const CONFIG_CLASSIFICATION_POLICIES: &str = "classifications";

// PUBLIC
pub const PUBLIC_BASE: &str = "public";
pub const PUBLIC_SOFTWARE_BASE: &str = "software";
pub const PUBLIC_VERSION: &str = "version";
pub const PUBLIC_SYSTEM_BASE: &str = "system";
pub const PUBLIC_INFO: &str = "info";
pub const PUBLIC_SHARES_BASE: &str = "shares";
pub const PUBLIC_DOWNLOAD_SHARES: &str = "downloads";
pub const PUBLIC_UPLOAD_SHARES: &str = "uploads";

/// user agent header
pub const APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "|", env!("CARGO_PKG_VERSION"));

// retry config
pub const MAX_RETRIES: u32 = 5;
pub const MIN_RETRY_DELAY: u64 = 600; // in milliseconds (0.6 seconds)
pub const MAX_RETRY_DELAY: u64 = 20 * 1000; // in milliseconds (20 seconds)