rusotp 0.5.0

Rust implementation of the HOTP and TOTP algorithms
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

// Copyright (c) Indrajit Roy
//
// This file is licensed under the Affero General Public License version 3 or
// any later version.
//
// See the file LICENSE for details.

use crate::ffi::converter::to_cstr;
use crate::ffi::{HotpConfig, TotpConfig};
use std::ffi::c_char;
use std::ptr::null;

/// FFI-safe result type for operations returning a string.
///
/// # Fields
/// - `success`: Indicates if the operation was successful.
/// - `data`: Pointer to a C string containing the result data (valid if `success` is true).
/// - `error`: Pointer to a C string containing the error message (valid if `success` is false).
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct StringResult {
    pub success: bool,
    pub data: *const c_char,
    pub error: *const c_char,
}

pub(crate) fn error_string_result(error: &str) -> StringResult {
    StringResult {
        success: false,
        data: null(),
        error: to_cstr(error),
    }
}

pub(crate) fn success_string_result(data: &str) -> StringResult {
    StringResult {
        success: true,
        data: to_cstr(data),
        error: null(),
    }
}

/// FFI-safe result type for operations returning a boolean value.
///
/// # Fields
/// - `success`: Indicates if the operation was successful.
/// - `data`: The boolean result (valid if `success` is true).
/// - `error`: Pointer to a C string containing the error message (valid if `success` is false).
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct BoolResult {
    pub success: bool,
    pub data: bool,
    pub error: *const c_char,
}

pub(crate) fn error_bool_result(error: &str) -> BoolResult {
    BoolResult {
        success: false,
        data: false,
        error: to_cstr(error),
    }
}

pub(crate) fn success_bool_result(data: bool) -> BoolResult {
    BoolResult {
        success: true,
        data,
        error: null(),
    }
}

/// FFI-safe result type for operations returning a `HotpConfig` pointer.
///
/// # Fields
/// - `success`: Indicates if the operation was successful.
/// - `data`: Pointer to a `HotpConfig` (valid if `success` is true).
/// - `error`: Pointer to a C string containing the error message (valid if `success` is false).
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct HotpConfigResult {
    pub success: bool,
    pub data: *const HotpConfig,
    pub error: *const c_char,
}

pub(crate) fn error_hotp_config_result(error: &str) -> HotpConfigResult {
    HotpConfigResult {
        success: false,
        data: null(),
        error: to_cstr(error),
    }
}

pub(crate) fn success_hotp_config_result(data: HotpConfig) -> HotpConfigResult {
    HotpConfigResult {
        success: true,
        data: Box::into_raw(Box::new(data)) as *const HotpConfig,
        error: null(),
    }
}

/// FFI-safe result type for operations returning a `TotpConfig` pointer.
///
/// # Fields
/// - `success`: Indicates if the operation was successful.
/// - `data`: Pointer to a `TotpConfig` (valid if `success` is true).
/// - `error`: Pointer to a C string containing the error message (valid if `success` is false).
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct TotpConfigResult {
    pub success: bool,
    pub data: *const TotpConfig,
    pub error: *const c_char,
}

pub(crate) fn error_totp_config_result(error: &str) -> TotpConfigResult {
    TotpConfigResult {
        success: false,
        data: null(),
        error: to_cstr(error),
    }
}

pub(crate) fn success_totp_config_result(data: TotpConfig) -> TotpConfigResult {
    TotpConfigResult {
        success: true,
        data: Box::into_raw(Box::new(data)) as *const TotpConfig,
        error: null(),
    }
}