- COPYRIGHT AND LICENSE
gen-google-auth-qrcode - Generate Google authenticator QR code (barcode) from a secret key
This document describes version 0.004 of gen-google-auth-qrcode (from Perl distribution App-GoogleAuthUtils), released on 2018-04-18.
% gen-google-auth-qrcode [options] <secret_key> <issuer> [account]
% gen-google-auth-qrcode 6XDT6TSOGR5SCWKHXZ4DFBRXJVZGAKAW example.com
When generating a new 2FA token, you are usually presented with a secret key as well as a 2D barcode (QR code) representation of this secret key. You are advised to store the secret key and it's usually more convenient to store the key code instead of the QR code. But when entering the secret key to the Google authenticator app, it's often more convenient to scan the barcode instead of typing or copy-pasting the code.
This utility will convert the secret key code into bar code (opened in a browser) so you can conveniently scan the bar code into your app.
* marks required options.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C gen-google-auth-qrcode gen-google-auth-qrcode
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete gen-google-auth-qrcode 'p/*/`gen-google-auth-qrcode`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-GoogleAuthUtils.
Source repository is at https://github.com/perlancar/perl-App-GoogleAuthUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-GoogleAuthUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
This software is copyright (c) 2018 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.