summaryrefslogtreecommitdiff
path: root/packages/anastasis-core/src/challenge-feedback-types.ts
blob: d6a2e3e8052219ceae5ea13218a421b8012c8fc1 (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
import { AmountString, HttpStatusCode } from "@gnu-taler/taler-util";

export enum ChallengeFeedbackStatus {
  Solved = "solved",
  ServerFailure = "server-failure",
  TruthUnknown = "truth-unknown",
  Redirect = "redirect",
  Payment = "payment",
  Pending = "pending",
  Message = "message",
  Unsupported = "unsupported",
  RateLimitExceeded = "rate-limit-exceeded",
  AuthIban = "auth-iban",
}

export type ChallengeFeedback =
  | ChallengeFeedbackSolved
  | ChallengeFeedbackPending
  | ChallengeFeedbackPayment
  | ChallengeFeedbackServerFailure
  | ChallengeFeedbackRateLimitExceeded
  | ChallengeFeedbackTruthUnknown
  | ChallengeFeedbackRedirect
  | ChallengeFeedbackMessage
  | ChallengeFeedbackUnsupported
  | ChallengeFeedbackAuthIban;

/**
 * Challenge has been solved and the key share has
 * been retrieved.
 */
export interface ChallengeFeedbackSolved {
  state: ChallengeFeedbackStatus.Solved;
}

/**
 * The challenge given by the server is unsupported
 * by the current anastasis client.
 */
export interface ChallengeFeedbackUnsupported {
  state: ChallengeFeedbackStatus.Unsupported;
  http_status: HttpStatusCode;
  /**
   * Human-readable identifier of the unsupported method.
   */
  unsupported_method: string;
}

/**
 * The user tried to answer too often with a wrong answer.
 */
export interface ChallengeFeedbackRateLimitExceeded {
  state: ChallengeFeedbackStatus.RateLimitExceeded;
}

/**
 * Instructions for performing authentication via an
 * IBAN bank transfer.
 */
export interface ChallengeFeedbackAuthIban {
  state: ChallengeFeedbackStatus.AuthIban;

  /**
   * Amount that should be transfered for a successful authentication.
   */
  challenge_amount: AmountString;

  /**
   * Account that should be credited.
   */
  credit_iban: string;

  /**
   * Creditor name.
   */
  business_name: string;

  /**
   * Unstructured remittance information that should
   * be contained in the bank transfer.
   */
  wire_transfer_subject: string;
}

/**
 * Challenge still needs to be solved.
 */
export interface ChallengeFeedbackPending {
  state: ChallengeFeedbackStatus.Pending;
}

/**
 * Human-readable response from the provider
 * after the user failed to solve the challenge
 * correctly.
 */
export interface ChallengeFeedbackMessage {
  state: ChallengeFeedbackStatus.Message;
  message: string;
}

/**
 * The server experienced a temporary failure.
 */
export interface ChallengeFeedbackServerFailure {
  state: ChallengeFeedbackStatus.ServerFailure;
  http_status: HttpStatusCode | 0;

  /**
   * Taler-style error response, if available.
   */
  error_response?: any;
}

/**
 * The truth is unknown to the provider.  There
 * is no reason to continue trying to solve any
 * challenges in the policy.
 */
export interface ChallengeFeedbackTruthUnknown {
  state: ChallengeFeedbackStatus.TruthUnknown;
}

/**
 * The user should be asked to go to a URL
 * to complete the authentication there.
 */
export interface ChallengeFeedbackRedirect {
  state: ChallengeFeedbackStatus.Redirect;
  http_status: number;
  redirect_url: string;
}

/**
 * A payment is required before the user can
 * even attempt to solve the challenge.
 */
export interface ChallengeFeedbackPayment {
  state: ChallengeFeedbackStatus.Payment;

  taler_pay_uri: string;

  provider: string;

  /**
   * FIXME: Why is this required?!
   */
  payment_secret: string;
}