summaryrefslogtreecommitdiff
path: root/anastasis/src/main/java/net/taler/anastasis/models/ReducerState.kt
blob: 036d07586b7f9e9ed72d4ca57dc81726a44dfb77 (plain)
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
package net.taler.anastasis.models

import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.AccountBalance
import androidx.compose.material.icons.filled.Email
import androidx.compose.material.icons.filled.Mail
import androidx.compose.material.icons.filled.QuestionAnswer
import androidx.compose.material.icons.filled.QuestionMark
import androidx.compose.material.icons.filled.Sms
import androidx.compose.material.icons.filled.Token
import androidx.compose.ui.graphics.vector.ImageVector
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonClassDiscriminator
import net.taler.anastasis.R
import net.taler.common.Amount
import net.taler.common.Timestamp

@Serializable
@OptIn(ExperimentalSerializationApi::class)
@JsonClassDiscriminator("reducer_type")
sealed class ReducerState {
    @Serializable
    @SerialName("backup")
    data class Backup(
        @SerialName("backup_state")
        val backupState: BackupStates,
        val continents: List<ContinentInfo>? = null,
        val countries: List<CountryInfo>? = null,
        @SerialName("identity_attributes")
        val identityAttributes: Map<String, String>? = null,
        @SerialName("authentication_providers")
        val authenticationProviders: Map<String, AuthenticationProviderStatus>? = null,
        @SerialName("authentication_methods")
        val authenticationMethods: List<AuthMethod>? = null,
        @SerialName("required_attributes")
        val requiredAttributes: List<UserAttributeSpec>? = null,
        @SerialName("selected_continent")
        val selectedContinent: String? = null,
        @SerialName("selected_country")
        val selectedCountry: String? = null,
        @SerialName("secret_name")
        val secretName: String? = null,
        val policies: List<Policy>? = null,
        @SerialName("recovery_data")
        val recoveryData: RecoveryData? = null,
        @SerialName("policy_providers")
        val policyProviders: List<PolicyProvider>? = null,
        @SerialName("success_details")
        val successDetails: Map<String, SuccessDetail>? = null,
        val payments: List<String>? = null,
        @SerialName("policy_payment_requests")
        val policyPaymentRequests: List<PolicyPaymentRequest>? = null,
        @SerialName("core_secret")
        val coreSecret: CoreSecret? = null,
        val expiration: Timestamp? = null,
        @SerialName("upload_fees")
        val uploadFees: List<UploadFee>? = null,
        @SerialName("truth_upload_payment_secrets")
        val truthUploadPaymentSecrets: Map<String, String>? = null,
    ): ReducerState() {
        @Serializable
        data class RecoveryData(
            @SerialName("truth_metadata")
            val truthMetadata: Map<String, TruthMetaData>,
            @SerialName("recovery_document")
            val recoveryDocument: RecoveryDocument,
        )

        @Serializable
        data class PolicyPaymentRequest(
            val payto: String,
            val provider: String,
        )

        @Serializable
        data class UploadFee(
            val fee: Amount,
        )
    }

    @Serializable
    @SerialName("recovery")
    data class Recovery(
        @SerialName("recovery_state")
        val recoveryState: RecoveryStates,
        @SerialName("identity_attributes")
        val identityAttributes: Map<String, String>? = null,
        val continents: List<ContinentInfo>? = null,
        val countries: List<CountryInfo>? = null,
        @SerialName("selected_continent")
        val selectedContinent: String? = null,
        @SerialName("selected_country")
        val selectedCountry: String? = null,
        @SerialName("required_attributes")
        val requiredAttributes: List<UserAttributeSpec>? = null,
        @SerialName("recovery_information")
        val recoveryInformation: RecoveryInformation? = null,
        @SerialName("recovery_document")
        val recoveryDocument: RecoveryInternalData? = null,
        @SerialName("verbatim_recovery_document")
        val verbatimRecoveryDocument: RecoveryDocument? = null,
        @SerialName("selected_challenge_uuid")
        val selectedChallengeUuid: String? = null,
        @SerialName("selected_version")
        val selectedVersion: SelectedVersionInfo? = null,
        @SerialName("challenge_feedback")
        val challengeFeedback: Map<String, ChallengeFeedback>? = null,
        // TODO: recovered_key_shares
        val coreSecret: CoreSecret? = null,
        @SerialName("authentication_providers")
        val authenticationProviders: Map<String, AuthenticationProviderStatus>? = null,
    ): ReducerState()

    @Serializable
    @SerialName("error")
    data class Error(
        val code: Int,
        val hint: String? = null,
        val detail: String? = null,
    ): ReducerState()
}

@Serializable
data class ContinentInfo(
    val name: String,
)

@Serializable
data class CountryInfo(
    val code: String,
    val name: String,
    val continent: String,
)

@Serializable
data class Policy(
    val methods: List<PolicyMethod>,
) {
    @Serializable
    data class PolicyMethod(
        @SerialName("authentication_method")
        val authenticationMethod: Int,
        val provider: String
    )
}

@Serializable
data class PolicyProvider(
    @SerialName("provider_url")
    val providerUrl: String,
)

@Serializable
data class SuccessDetail(
    @SerialName("policy_version")
    val policyVersion: Int,
    @SerialName("policy_expiration")
    val policyExpiration: Timestamp,
)

@Serializable
data class CoreSecret(
    val mime: String,
    val value: String,
    val filename: String? = null,
)

@Serializable
data class AuthMethod(
    val type: Type,
    val instructions: String,
    val challenge: String,
    @SerialName("mime_type")
    val mimeType: String? = null,
) {
    @Serializable
    enum class Type(
        val icon: ImageVector,
        val nameRes: Int,
    ) {
        @SerialName("question")
        Question(Icons.Default.QuestionAnswer, R.string.auth_method_question),

        @SerialName("sms")
        Sms(Icons.Default.Sms, R.string.auth_method_sms),

        @SerialName("email")
        Email(Icons.Default.Email, R.string.auth_method_email),

        @SerialName("iban")
        Iban(Icons.Default.AccountBalance, R.string.auth_method_iban),

        @SerialName("mail")
        Mail(Icons.Default.Mail, R.string.auth_method_mail),

        @SerialName("totp")
        Totp(Icons.Default.Token, R.string.auth_method_totp),

        Unknown(Icons.Default.QuestionMark, R.string.unknown),
    }
}

@Serializable
data class ChallengeInfo(
    val instructions: String,
    val type: String,
    val uuid: String,
)

@Serializable
data class UserAttributeSpec(
    val label: String,
    val name: String,
    val type: String,
    val uuid: String,
    val widget: String,
    val optional: Boolean? = null,
    @SerialName("validation-regex")
    val validationRegex: String? = null,
    @SerialName("validation-logic")
    val validationLogic: String? = null,
    val autocomplete: String? = null,
)

@Serializable
data class RecoveryInternalData(
    @SerialName("secret_name")
    val secretName: String,
    @SerialName("provider_url")
    val providerUrl: String,
    val version: Int,
)

@Serializable
data class RecoveryInformation(
    val challenges: List<ChallengeInfo>,
    val policies: List<List<Policy>>,
) {
    @Serializable
    data class Policy(
        val uuid: String,
    )
}

@Serializable
data class TruthMetaData(
    val uuid: String,
    @SerialName("key_share")
    val keyShare: String,
    @SerialName("policy_index")
    val policyIndex: Int,
    @SerialName("pol_method_index")
    val polMethodIndex: Int,
    val nonce: String,
    @SerialName("truth_key")
    val truthKey: String,
    @SerialName("master_salt")
    val masterSalt: String,
)

@Serializable
enum class BackupStates {
    @SerialName("CONTINENT_SELECTING")
    ContinentSelecting,

    @SerialName("COUNTRY_SELECTING")
    CountrySelecting,

    @SerialName("USER_ATTRIBUTES_COLLECTING")
    UserAttributesCollecting,

    @SerialName("AUTHENTICATIONS_EDITING")
    AuthenticationsEditing,

    @SerialName("POLICIES_REVIEWING")
    PoliciesReviewing,

    @SerialName("SECRET_EDITING")
    SecretEditing,

    @SerialName("TRUTHS_PAYING")
    TruthsPaying,

    @SerialName("POLICIES_PAYING")
    PoliciesPaying,

    @SerialName("BACKUP_FINISHED")
    BackupFinished;
}

@Serializable
enum class RecoveryStates {
    @SerialName("CONTINENT_SELECTING")
    ContinentSelecting,

    @SerialName("COUNTRY_SELECTING")
    CountrySelecting,

    @SerialName("USER_ATTRIBUTES_COLLECTING")
    UserAttributesCollecting,

    @SerialName("SECRET_SELECTING")
    SecretSelecting,

    @SerialName("CHALLENGE_SELECTING")
    ChallengeSelecting,

    @SerialName("CHALLENGE_PAYING")
    ChallengePaying,

    @SerialName("CHALLENGE_SOLVING")
    ChallengeSolving,

    @SerialName("RECOVERY_FINISHED")
    RecoveryFinished;
}

@Serializable
data class MethodSpec(
    val type: AuthMethod.Type,
    @SerialName("usage_fee")
    val usageFee: String,
)



@OptIn(ExperimentalSerializationApi::class)
@Serializable
@JsonClassDiscriminator("status")
sealed class AuthenticationProviderStatus {
    @Serializable
    @SerialName("not-contacted")
    object NotContacted: AuthenticationProviderStatus()

    @Serializable
    @SerialName("ok")
    data class Ok(
        @SerialName("annual_fee")
        val annualFee: String,
        @SerialName("business_name")
        val businessName: String,
        val currency: String? = null,
        @SerialName("http_status")
        val httpStatus: Int,
        @SerialName("liability_limit")
        val liabilityLimit: String,
        @SerialName("provider_salt")
        val providerSalt: String,
        @SerialName("storage_limit_in_megabytes")
        val storageLimitInMegabytes: Int,
        @SerialName("truth_upload_fee")
        val truthUploadFee: String,
        val methods: List<MethodSpec>,
    ): AuthenticationProviderStatus()

    @Serializable
    @SerialName("disabled")
    object Disabled : AuthenticationProviderStatus()

    @Serializable
    @SerialName("error")
    data class Error(
        @SerialName("http_status")
        val httpStatus: Int? = null,
        val code: Int,
        val hint: String? = null,
    ): AuthenticationProviderStatus()
}

// TODO: ReducerStateBackupUserAttributesCollecting

// TODO: SolveChallengeAnswerRequest

// TODO: SolveChallengePinRequest

// TODO: SolveChallengeHashRequest

// TODO: PolicyMember

@Serializable
data class SelectedVersionInfoProviders(
    val url: String,
    val version: Int,
)

@Serializable
data class SelectedVersionInfo(
    val attributeMask: Int,
    val providers: SelectedVersionInfoProviders,
)

// TODO: DiscoveryCursor

// TODO: PolicyMetaInfo

// TODO: AggregatedPolicyMetaInfo

// TODO: DiscoveryResult