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
|
use std::borrow;
use std::ffi::{CStr, CString};
use std::fmt;
use std::os::raw::{c_char, c_int};
use libc::{c_void, free};
use rand::RngCore;
use rand::rngs::OsRng;
/// Error types returned by Nitrokey device or by the library.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum CommandError {
/// A packet with a wrong checksum has been sent or received.
WrongCrc,
/// A command tried to access an OTP slot that does not exist.
WrongSlot,
/// A command tried to generate an OTP on a slot that is not configured.
SlotNotProgrammed,
/// The provided password is wrong.
WrongPassword,
/// You are not authorized for this command or provided a wrong temporary
/// password.
NotAuthorized,
/// An error occurred when getting or setting the time.
Timestamp,
/// You did not provide a name for the OTP slot.
NoName,
/// This command is not supported by this device.
NotSupported,
/// This command is unknown.
UnknownCommand,
/// AES decryption failed.
AesDecryptionFailed,
/// An unknown error occurred.
Unknown(i64),
/// An unspecified error occurred.
Undefined,
/// You passed a string containing a null byte.
InvalidString,
/// A supplied string exceeded a length limit.
StringTooLong,
/// You passed an invalid slot.
InvalidSlot,
/// The supplied string was not in hexadecimal format.
InvalidHexString,
/// The target buffer was smaller than the source.
TargetBufferTooSmall,
/// An error occurred during random number generation.
RngError,
}
/// Log level for libnitrokey.
///
/// Setting the log level to a lower level enables all output from higher levels too. Currently,
/// only the log levels `Warning`, `DebugL1`, `Debug` and `DebugL2` are actually used.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum LogLevel {
/// Error messages. Currently not used.
Error,
/// Warning messages.
Warning,
/// Informational messages. Currently not used.
Info,
/// Basic debug messages, especially basic information on the sent and received packets.
DebugL1,
/// Detailed debug messages, especially detailed information on the sent and received packets.
Debug,
/// Very detailed debug messages, especially detailed information about the control flow for
/// device communication (for example function entries and exits).
DebugL2,
}
pub fn owned_str_from_ptr(ptr: *const c_char) -> String {
unsafe {
return CStr::from_ptr(ptr).to_string_lossy().into_owned();
}
}
pub fn result_from_string(ptr: *const c_char) -> Result<String, CommandError> {
if ptr.is_null() {
return Err(CommandError::Undefined);
}
unsafe {
let s = owned_str_from_ptr(ptr);
free(ptr as *mut c_void);
// An empty string can both indicate an error or be a valid return value. In this case, we
// have to check the last command status to decide what to return.
if s.is_empty() {
get_last_result().map(|_| s)
} else {
Ok(s)
}
}
}
pub fn get_command_result(value: c_int) -> Result<(), CommandError> {
match value {
0 => Ok(()),
other => Err(CommandError::from(other)),
}
}
pub fn get_last_result() -> Result<(), CommandError> {
let value = unsafe { nitrokey_sys::NK_get_last_command_status() } as c_int;
get_command_result(value)
}
pub fn get_last_error() -> CommandError {
return match get_last_result() {
Ok(()) => CommandError::Undefined,
Err(err) => err,
};
}
pub fn generate_password(length: usize) -> Result<Vec<u8>, CommandError> {
let mut rng = OsRng::new()?;
let mut data = vec![0u8; length];
rng.fill_bytes(&mut data[..]);
Ok(data)
}
pub fn get_cstring<T: Into<Vec<u8>>>(s: T) -> Result<CString, CommandError> {
CString::new(s).or(Err(CommandError::InvalidString))
}
impl CommandError {
fn as_str(&self) -> borrow::Cow<'static, str> {
match *self {
CommandError::WrongCrc => {
"A packet with a wrong checksum has been sent or received".into()
}
CommandError::WrongSlot => "The given OTP slot does not exist".into(),
CommandError::SlotNotProgrammed => "The given OTP slot is not programmed".into(),
CommandError::WrongPassword => "The given password is wrong".into(),
CommandError::NotAuthorized => {
"You are not authorized for this command or provided a wrong temporary \
password"
.into()
}
CommandError::Timestamp => "An error occurred when getting or setting the time".into(),
CommandError::NoName => "You did not provide a name for the OTP slot".into(),
CommandError::NotSupported => "This command is not supported by this device".into(),
CommandError::UnknownCommand => "This command is unknown".into(),
CommandError::AesDecryptionFailed => "AES decryption failed".into(),
CommandError::Unknown(x) => {
borrow::Cow::from(format!("An unknown error occurred ({})", x))
}
CommandError::Undefined => "An unspecified error occurred".into(),
CommandError::InvalidString => "You passed a string containing a null byte".into(),
CommandError::StringTooLong => "The supplied string is too long".into(),
CommandError::InvalidSlot => "The given slot is invalid".into(),
CommandError::InvalidHexString => {
"The supplied string is not in hexadecimal format".into()
}
CommandError::TargetBufferTooSmall => "The target buffer is too small".into(),
CommandError::RngError => "An error occurred during random number generation".into(),
}
}
}
impl fmt::Display for CommandError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.as_str())
}
}
impl From<c_int> for CommandError {
fn from(value: c_int) -> Self {
match value {
1 => CommandError::WrongCrc,
2 => CommandError::WrongSlot,
3 => CommandError::SlotNotProgrammed,
4 => CommandError::WrongPassword,
5 => CommandError::NotAuthorized,
6 => CommandError::Timestamp,
7 => CommandError::NoName,
8 => CommandError::NotSupported,
9 => CommandError::UnknownCommand,
10 => CommandError::AesDecryptionFailed,
200 => CommandError::StringTooLong,
201 => CommandError::InvalidSlot,
202 => CommandError::InvalidHexString,
203 => CommandError::TargetBufferTooSmall,
x => CommandError::Unknown(x.into()),
}
}
}
impl From<rand::Error> for CommandError {
fn from(_error: rand::Error) -> Self {
CommandError::RngError
}
}
impl Into<i32> for LogLevel {
fn into(self) -> i32 {
match self {
LogLevel::Error => 0,
LogLevel::Warning => 1,
LogLevel::Info => 2,
LogLevel::DebugL1 => 3,
LogLevel::Debug => 4,
LogLevel::DebugL2 => 5,
}
}
}
|