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
#![deny(missing_docs)]
#![cfg_attr(not(feature = "clib"), deny(unsafe_code))]
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! This Rust crate can be used to interact with the Google Authenticator mobile app for 2-factor-authentication.
//! This Rust crates can generate secrets, generate codes, validate codes and present a QR-Code for scanning the secret.
//! It implements TOTP according to RFC6238
//!
//! # Examples
//!
//! ```rust
//! use google_authenticator::GoogleAuthenticator;
//!
//! let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
//!
//! let auth = GoogleAuthenticator::new();
//! let code = auth.get_code(secret,0).unwrap();
//! if auth.verify_code(secret, code.as_str(), 1, 0) {
//! println!("match!");
//! }
//! ```
mod authenticator;
pub use authenticator::*;
#[cfg(feature = "clib")]
use std::ffi::{CStr, CString};
#[cfg(feature = "clib")]
use std::os::raw::c_char;
lazy_static::lazy_static! {
/// A globally accessible, thread safe instance of a `GoogleAuthenticator`. Note that if the
/// code panics while this variable is in scope, the `std::sync::Mutex` can be poisoned,
/// preventing further access to this variable.
pub static ref GA_AUTH: GoogleAuthenticator = GoogleAuthenticator::new();
}
/// A macro that can be used for convenient access to the function
/// `GoogleAuthenticator::create_secret`, by providing a default of `32` to the `length` parameter.
#[macro_export]
macro_rules! create_secret {
($length: expr) => {
GA_AUTH.create_secret($length)
};
() => {
GA_AUTH.create_secret(32)
};
}
/// A macro that can be used for convenient access to the function
/// `GoogleAuthenticator::get_code`, by providing a default of the current time to the
/// `times_slice` parameter.
#[macro_export]
macro_rules! get_code {
($secret: expr, $time_slice: expr) => {
GA_AUTH.get_code($secret, time_slice)
};
($secret: expr) => {
GA_AUTH.get_code($secret, 0)
};
}
/// A macro that can be used for convenient access to the function
/// `GoogleAuthenticator::verify_code`, by providing a default of 0 to the `discrepancy` parameter,
/// and the current time to the `times_slice` parameter.
#[macro_export]
macro_rules! verify_code {
($secret: expr, $code: expr, $discrepancy: expr, $time_slice: expr) => {
GA_AUTH.verify_code($secret, $code, $discrepancy, $time_slice)
};
($secret: expr, $code: expr) => {
GA_AUTH.verify_code($secret, $code, 0, 0)
};
}
/// A macro that can be used for convenient access to the function
/// `GoogleAuthenticator::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.
#[macro_export]
macro_rules! qr_code_url {
($secret: expr, $name: expr, $title: expr, $width: expr, $height: expr, $level: expr) => {
GA_AUTH.qr_code_url($secret, $name, $title, $width, $height, $level)
};
($secret: expr, $name: expr, $title: expr) => {
GA_AUTH.qr_code_url(
$secret,
$name,
$title,
200,
200,
$crate::ErrorCorrectionLevel::Medium,
)
};
}
/// A macro that can be used for convenient access to the function
/// `GoogleAuthenticator::qr_code`, by providing a default of 200 to the `width` parameter, 200
/// to the `height` parameter, and `ErrorCorrectionLevel::Medium` to the `level` parameter.
#[macro_export]
macro_rules! qr_code {
($secret: expr, $name: expr, $title: expr, $width: expr, $height: expr, $level: expr) => {
GA_AUTH.qr_code($secret, $name, $title, $width, $height, $level)
};
($secret: expr, $name: expr, $title: expr) => {
GA_AUTH.qr_code(
$secret,
$name,
$title,
200,
200,
$crate::ErrorCorrectionLevel::Medium,
)
};
}
/// A function that can be used for convenient access to the function
/// `create_secret`, by providing a default of `32` to the `length` parameter.
#[cfg(feature = "clib")]
#[no_mangle]
pub extern "C" fn create_secret(len: u8) -> *const c_char {
CString::new(GA_AUTH.create_secret(len))
.expect("can't make secret.")
.into_raw()
}
/// 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.
#[cfg(all(feature = "with-qrcode", feature = "clib"))]
#[no_mangle]
pub unsafe extern "C" fn qr_code(
secret: *const c_char,
name: *const c_char,
title: *const c_char,
witdh: u32,
height: u32,
level: crate::ErrorCorrectionLevel,
) -> *const c_char {
CString::new(
GA_AUTH
.qr_code(
unsafe { CStr::from_ptr(secret) }.to_str().unwrap(),
unsafe { CStr::from_ptr(name) }.to_str().unwrap(),
unsafe { CStr::from_ptr(title) }.to_str().unwrap(),
witdh,
height,
level,
)
.expect("can't get qr code."),
)
.unwrap()
.into_raw()
}
/// # 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.
#[cfg(feature = "clib")]
#[no_mangle]
pub unsafe extern "C" fn qr_code_url(
secret: *const c_char,
name: *const c_char,
title: *const c_char,
witdh: u32,
height: u32,
level: crate::ErrorCorrectionLevel,
) -> *const c_char {
CString::new(GA_AUTH.qr_code_url(
unsafe { CStr::from_ptr(secret) }.to_str().unwrap(),
unsafe { CStr::from_ptr(name) }.to_str().unwrap(),
unsafe { CStr::from_ptr(title) }.to_str().unwrap(),
witdh,
height,
level,
))
.expect("can't get qrcode url now.")
.into_raw()
}
/// # 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.
#[cfg(feature = "clib")]
#[no_mangle]
pub unsafe extern "C" fn get_code(secret: *const c_char, time_slice: u64) -> *const c_char {
CString::new(
GA_AUTH
.get_code(
unsafe { CStr::from_ptr(secret) }.to_str().unwrap(),
time_slice,
)
.expect("can't get code now"),
)
.unwrap()
.into_raw()
}
/// # 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.
#[cfg(feature = "clib")]
#[no_mangle]
pub unsafe extern "C" fn verify_code(
secret: *const c_char,
code: *const c_char,
discrepancy: u64,
time_slice: u64,
) -> bool {
GA_AUTH.verify_code(
unsafe { CStr::from_ptr(secret) }.to_str().unwrap(),
unsafe { CStr::from_ptr(code) }.to_str().unwrap(),
discrepancy,
time_slice,
)
}
/// # Safety
/// A function that can be used for free returnd to C string
/// `str`, the string which be passed to outside
#[cfg(feature = "clib")]
#[no_mangle]
pub unsafe extern "C" fn free_str(str: *mut c_char) {
unsafe {
let _ = CString::from_raw(str);
}
}
#[cfg(test)]
mod tests {
#[cfg(feature = "with-qrcode")]
use crate::ErrorCorrectionLevel::*;
use crate::GoogleAuthenticator;
#[test]
fn create_secret() {
let auth = GoogleAuthenticator::new();
let secret = auth.create_secret(32);
//auth.get_code(secret.as_str(),0);
// println!("{:?}",secret);
assert_eq!(secret.len(), 32);
}
#[test]
fn test_code() {
let auth = GoogleAuthenticator::new();
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
assert_eq!(6, auth.get_code(secret, 0).unwrap().len());
}
#[test]
fn test_verify_code() {
let auth = GoogleAuthenticator::new();
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
#[cfg(feature = "with-qrcode")]
println!(
"{:?}",
auth.qr_code(secret, "qr_code", "name", 0, 0, Medium)
);
assert!(auth.verify_code(secret, "224124", 3, 1523610659 / 30));
}
#[test]
#[cfg(feature = "with-qrcode")]
fn test_qr_code_url() {
let auth = GoogleAuthenticator::new();
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
let url = auth.qr_code_url(secret, "secret code", "hi there", 0, 0, Medium);
println!("{}", url);
let resp = ureq::get(&url).call();
assert!(resp)
// panic!();
}
#[test]
#[cfg(feature = "with-qrcode")]
fn test_qr_code() {
let auth = GoogleAuthenticator::new();
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
auth.qr_code(secret, "secret_code", "hi", 0, 0, Medium)
.unwrap();
}
}
#[cfg(test)]
mod macro_tests {
use crate::GA_AUTH;
#[test]
fn create_secret() {
let secret = create_secret!();
assert_eq!(secret.len(), 32);
}
#[test]
fn test_code() {
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
assert_eq!(6, get_code!(secret).unwrap().len());
}
#[test]
fn test_verify_code() {
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
let code = get_code!(secret).unwrap();
assert!(verify_code!(secret, &code));
}
#[test]
#[cfg(feature = "with-qrcode")]
fn test_qr_code() {
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
assert!(qr_code!(secret, "qr_code", "name").is_ok());
}
#[test]
#[cfg(feature = "with-qrcode")]
fn test_qr_code_url() {
let secret = "I3VFM3JKMNDJCDH5BMBEEQAW6KJ6NOE3";
qr_code_url!(secret, "qr_code", "name");
}
}