CPP_OTP

A simple One Time Password (OTP) library in C/C++

This library originally derives from tilkinsc/COTP and made a step towards CPP from its original C roots. It was quite heavily rewritten. See here

Includes the CPP part of nayuki/QR-Code-generator to allow QR code generation in SVG format. See here

It remained compatible with Authy and Google Authenticator. (Be aware, that the latter one currently ignores some parameters.)

External Libraries Needed

OpenSSL is recommended to use with this library. You can easily switch off in the Makefile, but in case you do, you have to provide HMAC algorithms from another source. (Check the register_hmac_algo() method.)
The QR code generator library is included in source format.

Configuration

This library compiles with C++11. (g++ 10.3.0 on Linux was used. Feel free to extend it to allow compiling in other environments.)

Through the Makefile you can configure the use of OpenSSL and the QR capability. See there.

As I understand the RFC6238, the code length is no more then 9 chars. See RFC6238 Appendix. More precisely see RFC4226 5.3 where the "Dynamic Truncation" creates a 31bit unsigned number, which is no longer then 9 chars if written in decimal form.

License

This library is licensed under MIT License.

This product optionally includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.

Usage

Create a TOTP, have a fresh code and check the remaining time to the next code:

	size_t interval = 30;
	size_t digits = 6;
	std::string base32_secret = "THISISASECRET345";

	auto totp = cotp::TOTP(base32_secret, "SHA1", digits, interval);

	auto current_code = totp.code();

	auto remaining_secs = totp.seconds_to_next_code();

Create a pseudo-random secret (random number generator seeded during library init, with a very basic seeding):

	size_t base32_len = 16;

	auto base32_new_secret = cotp::OTP::random_base32(base32_len);

Get a current code based on an existing URI:

	auto otp = cotp::OTP_factory::get_instance().create("otpauth://totp/account%40example.com:name1?secret=THISISASECRET345&issuer=account%40example.com&algorithm=SHA1&digits=6&period=30");
	auto current_code = otp->code();

Verify a code for the current time with a validity window:

	// have totp defined

	uint64_t received_code = 123456;
	size_t validity_window = 4;

	auto result = totp.verify(received_code, validity_window);

Create a QR code for the URI in svg format:

	// have totp defined

	cotp::QR_code totp_qr;
	totp_qr.set_content(totp);
	auto totp_svg = totp_qr.get_svg();

Add some scaled decorations to the QR code:

	// have hotp defined

	cotp::QR_decoration decoration = { R"DECO(
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="%viewbox%" stroke="none">
	<g transform="scale(%scale%)">
		<style>.caption { font: bold 190px sans-serif; fill: white; }</style>
		<rect x="0" y="0" width="1144" height="1332" rx="50" fill="#444444"/>
		<text x="90" y="204" class="caption">SCAN ME</text>
		<rect x="72" y="264" width="1000" height="1000" fill="#FFFFFF"/>
	</g>
	<g transform="translate(%translate%)">
		%qr_code%
	</g>
</svg>)DECO",
	1144,
	1332,
	72,
	264
};

	cotp::QR_code hotp_qr;
	hotp_qr.set_content(hotp);
	hotp_qr.set_decoration(decoration);
	auto hotp_svg = hotp_qr.get_svg();

Check out the test file for more.

Notes:

According to several papers out there, the SHA-1 with 6 digits is the more widely used / supported version.
Watch on the potential exceptions. See details in code.
The OTP/TOTP/HOTP class implementations use assert() currently. May change later on.

Building

Use make.

The Makefile in the project root would call make in related sub-folders.

The library is created in .so format and not added to the system libraries. The test tool expects the libcotp.so in the parent folder, so do first cd test and then run ./cotp_test.

cmake

Simple cmake build files have been added to the project. Use these if you wish to install the libraries to a central location.

cmake -DCMAKE_INSTALL_PREFIX=/usr/local/spt -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=OFF -S . -B build
cmake --build build --parallel
(cd build; sudo make install)

TODO

possibly add option to read QR

sptrakesh / cpp-otp