1ykocli(1) General Commands Manual ykocli(1)
2
6 ykocli - Front end script to facilitate obtainment of TOTP tokens from
7 ykman
8
10 ykocli [action] [search_string]
11
13 The obtainment of TOTP tokens from ykman using the CLI requires manual
14 copying. In addition, there are times when the token displayed will
15 expire before it can be used, requiring the procedure be repeated.
16 ykocli is designed to mitigate these issues, in addition to providing
17 TOTP ADD, DELETE and RENAME capabilities. OATH entries that are stored
18 in the inserted YubiKey will be displayed in a table. You will then be
19 prompted to select an entry. That entry will then be used to obtain a
20 non-expired TOTP token. If only 1 entry matches the specified search
21 criteria, no table will be displayed and the appropriate TOTP token
22 will be immediately placed in the CopyQ clipboard. If the code dis‐
23 played is less than the REGEN value specified in the configuration
24 file, then another code will be generated for the next cycle interval,
25 greatly reducing or eliminating the use of an expired TOTP token. RE‐
26 GEN functionality is not available for TOTP OATH entries that require a
27 touch to generate a token.
28
30 ykocli allows for customization of certain items in the configuration.
31 If you wish to change an option in the configuration, first create a
33 copy: cp /etc/ykocli.conf $HOME/.ykocli.conf then modify only the
34 $HOME/.ykocli.conf version.
35 The configuration variables can be set as follows:
37 VARIABLE="value"
39 "value" needs to be quoted.
40 All shell escaping/quoting rules apply.
42 Here is a list of changable configuration options ykocli recognizes:
44 REGEN="5"
46 Default setting is 5 seconds This is the minimum threshold in
47 seconds for TOTP token expiration. If the remaining time for
48 the TOTP token is at or less than this value, ykocli will auto‐
49 matically create a replacement. REGEN functionality is not
50 available for TOTP OATH entries that require a touch to generate
51 a token.
52 EXITIME="5"
54 Default setting is 5 seconds This is the minimum threshold in
55 seconds for pressing the ENTER key to exit instead of returning
56 to BACKGROUND MODE.
57 FIGFONT="small"
59 Default setting is small. This is the font to be used by the
60 Figlet generated banner.
61 COLOR OVERRIDES
63 Monochrome, terminal defaults set value to "DEFAULT". Available
64 colors: RED, YELLOW, GREEN, BLUE, CYAN, PURPLE, GRAY, WHITE,
65 BLACK, LRED, LYELLOW, LGREEN, LBLUE, LCYAN, LPURPLE, LGRAY.
66 Placing an "L" in front of the color designates the "LIGHT" ver‐
67 sion; e.g. LRED - Light RED. Colors are assigned based upon the
68 content being displayed. Definitions of the abbreviated vari‐
69 ables are listed above each entry in ykocli.conf.
70
72 [action]
73 Supported actions are TOTP | RENAME | ADD | DELETE
74 [search_string]
76 ykocli will only display OATH entries that match the
77 search_string entered on the command line. If multiple matches
78 are found, you will be prompted to select the desired entry.
79 BKGND Konsole running under KDE Plasma ONLY. Invoke by using Konsole
81 background mode, i.e. konsole --background-mode -e ykocli bkgnd
82 or with an optional konsole profile, i.e. konsole --background-
83 mode --profile xyz -e ykocli bkgnd This command can be entered
84 using krunner, or as part of an autostart routine. The Konsole
85 window will start in the background. Press the default hotkey
86 CRTL+SHIFT+F12 to toggle the window between ACTIVE and BACK‐
87 GROUND. Examples for desktop and profile files can be found in
88 the /usr/share/doc/ykocli/examples directory. Alternatively,
89 you can invoke the following command from your home directory:
90 bash /usr/share/doc/ykocli/examples/ykocli-konsole-bkgnd.sh
91
93 ykocli requires the following backend tools:
94 * bash - GNU Bourne-Again SHell
96 * yubikey-manager (ykman) - Required to interface with the in‐
98 serted YubiKey
99 * copyq - Required to place TOTP tokens automatically in CopyQ
101 clipboard
102 * figlet - Required to facilate display formatting
104 * konsole - Required if background mode is desired
106 * zbar - Required for add TOTP tokens using SCAN mode
108
110 bash(1)
111 copyq(1)
112 zbarimg(1)
113
115 Gerald Cox <gbcox@fedoraproject.org>
116
118 https://bitbucket.org/gbcox/ykocli/
119 ykocli(1)