google-authenticator 0.4.2

This Rust crate can be used to interact with the Google Authenticator mobile app for 2-factor-authentication.
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

#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

/**
 * Controls the amount of fault tolerance that the QR code should accept. Require the feature
 * flag `with-qrcode`.
 */
typedef enum ErrorCorrectionLevel {
  /**
   * 7% of data bytes can be restored.
   */
  Low,
  /**
   * 15% of data bytes can be restored.
   */
  Medium,
  /**
   * 25% of data bytes can be restored.
   */
  Quartile,
  /**
   * 30% of data bytes can be restored.
   */
  High,
} ErrorCorrectionLevel;

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

/**
 * A function that can be used for convenient access to the function
 * `create_secret`, by providing a default of `32` to the `length` parameter.
 */
const char *create_secret(uint8_t len) CF_SWIFT_NAME(create_secret(len:));

#if defined(DEFINE_QRCODE)
/**
 * A function that can be used for convenient access to the function
 * `qr_code`, by providing a default of 200 to the `width` parameter, 200
 * to the `height` parameter, and `ErrorCorrectionLevel::Medium` to the `level` parameter.
 */
const char *qr_code(const char *secret,
                    const char *name,
                    const char *title,
                    uint32_t witdh,
                    uint32_t height,
                    enum ErrorCorrectionLevel level) CF_SWIFT_NAME(qr_code(secret:name:title:witdh:height:level:));
#endif

/**
 * # Safety
 * A function that can be used for convenient access to the function
 * `qr_code_url`, by providing a default of 200 to the `width` parameter, 200
 * to the `height` parameter, and `ErrorCorrectionLevel::Medium` to the `level` parameter.
 */
const char *qr_code_url(const char *secret,
                        const char *name,
                        const char *title,
                        uint32_t witdh,
                        uint32_t height,
                        enum ErrorCorrectionLevel level) CF_SWIFT_NAME(qr_code_url(secret:name:title:witdh:height:level:));

/**
 * # Safety
 * A function that can be used for convenient access to the function
 * `get_code`, by providing a default of the current time to the
 * `secret` parameter.
 * `times_slice` parameter.
 */
const char *get_code(const char *secret,
                     uint64_t time_slice) CF_SWIFT_NAME(get_code(secret:time_slice:));

/**
 * # Safety
 * A function that can be used for convenient access to the function
 * `verify_code`, by providing a default of 0 to the `discrepancy` parameter,
 * and the current time to the `times_slice` parameter.
 */
bool verify_code(const char *secret,
                 const char *code,
                 uint64_t discrepancy,
                 uint64_t time_slice) CF_SWIFT_NAME(verify_code(secret:code:discrepancy:time_slice:));

/**
 * # Safety
 * A function that can be used for free returnd to C string
 * `str`, the string which be passed to outside
 */
void free_str(char *str) CF_SWIFT_NAME(free_str(str:));

#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus