1 /* 2 * ProFTPD - mod_auth_otp database routines 3 * Copyright (c) 2015-2016 TJ Saunders 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 * This program is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU General Public License for more details. 14 * 15 * You should have received a copy of the GNU General Public License 16 * along with this program; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA. 18 * 19 * As a special exemption, TJ Saunders and other respective copyright holders 20 * give permission to link this program with OpenSSL, and distribute the 21 * resulting executable, without including the source code for OpenSSL in the 22 * source distribution. 23 */ 24 25 #ifndef MOD_AUTH_OTP_DB_H 26 #define MOD_AUTH_OTP_DB_H 27 28 #include "mod_auth_otp.h" 29 30 struct auth_otp_db { 31 pool *pool; 32 33 const char *select_query; 34 const char *update_query; 35 36 /* Database locking support. */ 37 struct flock db_lock; 38 int db_lockfd; 39 }; 40 41 int auth_otp_db_close(struct auth_otp_db *dbh); 42 struct auth_otp_db *auth_otp_db_open(pool *p, const char *dbinfo); 43 int auth_otp_db_rlock(struct auth_otp_db *dbh); 44 int auth_otp_db_wlock(struct auth_otp_db *dbh); 45 int auth_otp_db_unlock(struct auth_otp_db *dbh); 46 47 /* Ask if the table has info (secrets, counters) for this user. */ 48 int auth_otp_db_have_user_info(pool *p, struct auth_otp_db *dbh, 49 const char *user); 50 51 /* Retrieve the user's base32-encoded secret, and current counter (for HOTP). */ 52 int auth_otp_db_get_user_info(pool *p, struct auth_otp_db *dbh, 53 const char *user, const unsigned char **secret, size_t *secret_len, 54 unsigned long *counter); 55 56 /* Update the user's current counter (for HOTP). */ 57 int auth_otp_db_update_counter(struct auth_otp_db *dbh, const char *user, 58 unsigned long counter); 59 60 #endif /* MOD_AUTH_OTP_DB_H */ 61