aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/otputil.h
blob: 961d4eec3bd8bc7fd33614a3e1c1bc8385d9f302 (plain) (blame)
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
/*
 *  OTP Utilities
 *  Copyright (C) 2020 David M. Syzdek <david@syzdek.net>.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of David M. Syzdek nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 *  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DAVID M SYZDEK BE LIABLE FOR
 *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 */
/*
 *  @file src/otputil.h
 */
#ifndef _SRC_OTPUTIL_H
#define _SRC_OTPUTIL_H 1


///////////////
//           //
//  Headers  //
//           //
///////////////
#pragma mark - Headers

#include <otputil_compat.h>
#include <otputil.h>


///////////////////
//               //
//  Definitions  //
//               //
///////////////////
#pragma mark - Definitions

#ifndef TOTP_PREFIX
#define TOTP_PREFIX "totp-"
#endif


/////////////////
//             //
//  Datatypes  //
//             //
/////////////////
#pragma mark - Datatypes

typedef struct _otputil_cli_config otputil_config_t;
typedef struct _otputil_cli_widget otputil_widget_t;


struct _otputil_cli_widget
{
   const char *               name;
   const char *               desc;
   const char *               usage;
   const char *               short_opt;
   const char * const *       aliases;
   int                        arg_min;
   int                        arg_max;
   int  (*func_exec)(otputil_config_t * cnf);
   int  (*func_usage)(otputil_config_t * cnf);
};


struct _otputil_cli_config
{
   int                        quiet;
   int                        verbose;
   int                        opt_index;
   int                        prompt_user_pass;
   int                        prompt_otp_pass;
   int                        argc;
   char **                    argv;
   const char *               prog_name;
   const char *               otp_pass;
   const char *               user_pass;
   const otputil_widget_t *   widget;
   char                       otp_pass_buff[512];
};


//////////////////
//              //
//  Prototypes  //
//              //
//////////////////
#pragma mark - Prototypes

//--------------------------//
// miscellaneous prototypes //
//--------------------------//
#pragma mark miscellaneous prototypes

extern int
otputil_arguments(
         otputil_config_t *            cnf,
         int                           argc,
         char * const *                argv );


//--------------------------//
// widgets prototypes //
//--------------------------//
#pragma mark widgets prototypes

extern int
otputil_widget_hotp(
         otputil_config_t *            cnf );


extern int
otputil_widget_otp(
         otputil_config_t *            cnf );


extern int
otputil_widget_otp_usage(
         otputil_config_t *            cnf );


extern int
otputil_widget_skey(
         otputil_config_t *            cnf );


extern int
otputil_widget_skey_usage(
         otputil_config_t *            cnf );


extern int
otputil_widget_totp(
         otputil_config_t *            cnf );


#endif /* end of header file */