Annotation of libaitcfg/src/aitcfg.c, revision 1.17

1.2       misho       1: /*************************************************************************
                      2: * (C) 2008 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.17    ! misho       6: * $Id: aitcfg.c,v 1.16.6.4 2025/08/19 11:40:13 misho Exp $
1.2       misho       7: *
1.4       misho       8: **************************************************************************
                      9: The ELWIX and AITNET software is distributed under the following
                     10: terms:
                     11: 
                     12: All of the documentation and software included in the ELWIX and AITNET
                     13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
                     14: 
1.17    ! misho      15: Copyright 2004 - 2025
1.4       misho      16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
                     17: 
                     18: Redistribution and use in source and binary forms, with or without
                     19: modification, are permitted provided that the following conditions
                     20: are met:
                     21: 1. Redistributions of source code must retain the above copyright
                     22:    notice, this list of conditions and the following disclaimer.
                     23: 2. Redistributions in binary form must reproduce the above copyright
                     24:    notice, this list of conditions and the following disclaimer in the
                     25:    documentation and/or other materials provided with the distribution.
                     26: 3. All advertising materials mentioning features or use of this software
                     27:    must display the following acknowledgement:
                     28: This product includes software developed by Michael Pounov <misho@elwix.org>
                     29: ELWIX - Embedded LightWeight unIX and its contributors.
                     30: 4. Neither the name of AITNET nor the names of its contributors
                     31:    may be used to endorse or promote products derived from this software
                     32:    without specific prior written permission.
                     33: 
                     34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
                     35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     44: SUCH DAMAGE.
                     45: */
1.1       misho      46: #include "global.h"
                     47: 
                     48: 
                     49: #pragma GCC visibility push(hidden)
                     50: 
1.5       misho      51: int cfg_Errno;
                     52: char cfg_Error[STRSIZ];
                     53: 
1.9       misho      54: int
1.8       misho      55: cfg_Write(FILE *f, char *fmt, ...)
                     56: {
                     57:        int ret = 0;
                     58:        va_list lst;
                     59: 
                     60:        va_start(lst, fmt);
                     61:        ret = vfprintf(f, fmt, lst);
                     62:        va_end(lst);
                     63: 
                     64:        return ret;
                     65: }
                     66: 
1.9       misho      67: int
1.5       misho      68: cfg_tree_cmp(struct tagCfg *a, struct tagCfg *b)
                     69: {
                     70:        int ret;
                     71: 
                     72:        assert(a && b);
                     73: 
1.14      misho      74:        ret = ((AIT_KEY(&a->cfg_sec) << 15) | AIT_KEY(&a->cfg_attr)) - 
                     75:                ((AIT_KEY(&b->cfg_sec) << 15) | AIT_KEY(&b->cfg_attr));
1.5       misho      76: 
                     77:        if (ret < 0)
                     78:                return -1;
                     79:        else if (ret > 0)
                     80:                return 1;
                     81: 
                     82:        return ret;
                     83: }
                     84: 
                     85: RB_GENERATE(tagRC, tagCfg, cfg_node, cfg_tree_cmp);
1.1       misho      86: 
                     87: #pragma GCC visibility pop
                     88: 
                     89: 
1.5       misho      90: // cfg_GetErrno() Get error code of last operation
1.9       misho      91: int
1.5       misho      92: cfg_GetErrno()
                     93: {
                     94:        return cfg_Errno;
                     95: }
                     96: 
                     97: // cfg_GetError() Get error text of last operation
1.9       misho      98: const char *
1.5       misho      99: cfg_GetError()
                    100: {
                    101:        return cfg_Error;
                    102: }
                    103: 
                    104: // cfg_SetErr() Set error to variables for internal use!!!
1.9       misho     105: void
1.5       misho     106: cfg_SetErr(int eno, char *estr, ...)
                    107: {
                    108:        va_list lst;
                    109: 
                    110:        cfg_Errno = eno;
                    111:        memset(cfg_Error, 0, sizeof cfg_Error);
                    112:        va_start(lst, estr);
                    113:        vsnprintf(cfg_Error, sizeof cfg_Error, estr, lst);
                    114:        va_end(lst);
                    115: }
                    116: 
                    117: 
1.1       misho     118: /*
1.5       misho     119:  * cfgInitConfig() - Init config root
                    120:  *
1.12      misho     121:  * return: NULL error or !=NULL allocated config root
1.5       misho     122:  */
1.12      misho     123: cfg_root_t *
                    124: cfgInitConfig()
1.1       misho     125: {
1.12      misho     126:        cfg_root_t *cfg = NULL;
                    127: 
                    128:        cfg = e_malloc(sizeof(cfg_root_t));
                    129:        if (!cfg) {
                    130:                cfg_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
                    131:                return NULL;
                    132:        } else
                    133:                memset(cfg, 0, sizeof(cfg_root_t));
1.1       misho     134: 
1.5       misho     135:        pthread_mutex_init(&cfg->rc_mtx, NULL);
                    136: 
1.11      misho     137:        TAILQ_INIT(cfg);
1.5       misho     138:        RB_INIT(cfg);
1.12      misho     139:        return cfg;
                    140: }
                    141: 
                    142: /*
                    143:  * cfgEndConfig() - Free resources & config root
                    144:  *
                    145:  * @pcfg = Config root
                    146:  * return: none
                    147:  */
                    148: void
                    149: cfgEndConfig(cfg_root_t **pcfg)
                    150: {
                    151:        if (pcfg && *pcfg) {
                    152:                cfgClearConfig(*pcfg);
                    153:                pthread_mutex_destroy(&(*pcfg)->rc_mtx);
                    154:                e_free(*pcfg);
                    155:                *pcfg = NULL;
                    156:        }
1.1       misho     157: }
                    158: 
                    159: /*
1.17    ! misho     160:  * cfgInitConfigExt() - Init existed config root
        !           161:  *
        !           162:  * @cfg = Config root
        !           163:  * return: -1 error or 0 inited config root
        !           164:  */
        !           165: int
        !           166: cfgInitConfigExt(cfg_root_t * __restrict cfg)
        !           167: {
        !           168:        if (!cfg) {
        !           169:                cfg_SetErr(EINVAL, "Invalid parameter");
        !           170:                return -1;
        !           171:        }
        !           172: 
        !           173:        memset(cfg, 0, sizeof(cfg_root_t));
        !           174: 
        !           175:        pthread_mutex_init(&cfg->rc_mtx, NULL);
        !           176: 
        !           177:        TAILQ_INIT(cfg);
        !           178:        RB_INIT(cfg);
        !           179:        return 0;
        !           180: }
        !           181: 
        !           182: /*
1.5       misho     183:  * cfgLoadConfig() - Load config from file
                    184:  *
                    185:  * @cfgName = Config filename
                    186:  * @cfg = Config root
                    187:  * return: -1 error or 0 ok
                    188:  */
                    189: int
                    190: cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg)
1.1       misho     191: {
                    192:        FILE *f;
                    193:        int ret;
                    194: 
1.17    ! misho     195:        if (!cfgName || cfgInitConfigExt(cfg)) {
1.5       misho     196:                cfg_SetErr(EINVAL, "Invalid parameter(s)");
1.1       misho     197:                return -1;
1.12      misho     198:        }
1.1       misho     199: 
1.5       misho     200:        f = fopen(cfgName, "r");
                    201:        if (!f) {
1.1       misho     202:                LOGERR;
                    203:                return -1;
                    204:        }
                    205: 
1.5       misho     206:        ret = cfgReadConfig(f, cfg);
1.1       misho     207: 
                    208:        fclose(f);
                    209:        return ret;
                    210: }
                    211: 
                    212: /*
1.7       misho     213:  * cfgClearConfig() - Clear config and free resources
1.5       misho     214:  *
                    215:  * @cfg = Config root
                    216:  * return: none
                    217:  */
                    218: void
1.7       misho     219: cfgClearConfig(cfg_root_t * __restrict cfg)
1.1       misho     220: {
1.5       misho     221:        struct tagCfg *av;
1.1       misho     222: 
1.5       misho     223:        if (!cfg)
1.1       misho     224:                return;
                    225: 
1.5       misho     226:        CFG_RC_LOCK(cfg);
1.11      misho     227:        while ((av = TAILQ_FIRST(cfg))) {
                    228:                TAILQ_REMOVE(cfg, av, cfg_next);
1.5       misho     229: 
                    230:                AIT_FREE_VAL(&av->cfg_val);
                    231:                AIT_FREE_VAL(&av->cfg_attr);
                    232:                AIT_FREE_VAL(&av->cfg_sec);
1.9       misho     233:                e_free(av);
1.1       misho     234:        }
1.5       misho     235:        cfg->rbh_root = NULL;
                    236:        CFG_RC_UNLOCK(cfg);
1.7       misho     237: }
                    238: 
                    239: /*
                    240:  * cfgUnloadConfig() - Unload config from memory and destroy resources
                    241:  *
                    242:  * @cfg = Config root
                    243:  * return: none
                    244:  */
                    245: void
                    246: cfgUnloadConfig(cfg_root_t * __restrict cfg)
                    247: {
                    248:        if (!cfg)
                    249:                return;
1.1       misho     250: 
1.7       misho     251:        cfgClearConfig(cfg);
1.5       misho     252:        pthread_mutex_destroy(&cfg->rc_mtx);
1.17    ! misho     253:        memset(&cfg->rc_mtx, 0, sizeof cfg->rc_mtx);
1.1       misho     254: }
                    255: 
1.3       misho     256: /*
1.5       misho     257:  * cfgCreateConfig() - Create config file from memory
                    258:  *
1.3       misho     259:  * @csConfigName = New config filename
1.5       misho     260:  * @cfg = Config root
                    261:  * @whitespace = Additional whitespace characters to file
                    262:  * return: -1 error or 0 ok
                    263:  */
                    264: int
                    265: cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg, int whitespace)
1.3       misho     266: {
                    267:        FILE *f;
                    268:        int ret;
                    269: 
                    270:        if (!csConfigName || !cfg)
                    271:                return -1;
                    272: 
1.5       misho     273:        f = fopen(csConfigName, "w");
1.3       misho     274:        if (!f) {
                    275:                LOGERR;
                    276:                return -1;
                    277:        }
                    278:        
1.16      misho     279:        ret = cfgWriteConfigRaw(f, cfg, whitespace);
1.3       misho     280: 
                    281:        fclose(f);
                    282:        return ret;
                    283: }
1.8       misho     284: 
                    285: /*
                    286:  * cfgInitPasswd() - Init password root
                    287:  *
1.12      misho     288:  * return: NULL error or !=NULL allocated password root
1.8       misho     289:  */
1.12      misho     290: pwd_root_t *
                    291: cfgInitPasswd()
1.8       misho     292: {
1.12      misho     293:        pwd_root_t *pwd = NULL;
                    294: 
                    295:        pwd = e_malloc(sizeof(pwd_root_t));
                    296:        if (!pwd) {
                    297:                cfg_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
                    298:                return NULL;
                    299:        } else
                    300:                memset(pwd, 0, sizeof(pwd_root_t));
1.8       misho     301: 
                    302:        pthread_mutex_init(&pwd->pwd_mtx, NULL);
                    303: 
                    304:        SLIST_INIT(pwd);
                    305:        RB_INIT(pwd);
                    306:        return 0;
                    307: }
                    308: 
                    309: /*
1.12      misho     310:  * cfgEndPasswd() - Free resources & password root
                    311:  *
                    312:  * @ppwd = Password root
                    313:  * return: none
                    314:  */
                    315: void
                    316: cfgEndPasswd(pwd_root_t **ppwd)
                    317: {
                    318:        if (ppwd && *ppwd) {
                    319:                cfgClearPasswd(*ppwd);
                    320:                pthread_mutex_destroy(&(*ppwd)->pwd_mtx);
                    321:                e_free(*ppwd);
                    322:                *ppwd = NULL;
                    323:        }
                    324: }
                    325: 
                    326: /*
1.8       misho     327:  * cfgLoadPasswd() - Load passwords from file
                    328:  *
                    329:  * @pwdName = Passwords filename
                    330:  * @pwd = Password root
                    331:  * return: -1 error or 0 ok
                    332:  */
                    333: int
                    334: cfgLoadPasswd(const char *pwdName, pwd_root_t * __restrict pwd)
                    335: {
                    336:        FILE *f;
                    337:        int ret;
                    338: 
                    339:        if (!pwdName || !pwd) {
                    340:                cfg_SetErr(EINVAL, "Invalid parameter(s)");
                    341:                return -1;
1.12      misho     342:        } else {
1.15      misho     343:                memset(pwd, 0, sizeof(pwd_root_t));
                    344: 
1.12      misho     345:                pthread_mutex_init(&pwd->pwd_mtx, NULL);
                    346: 
                    347:                SLIST_INIT(pwd);
                    348:                RB_INIT(pwd);
                    349:        }
1.8       misho     350: 
                    351:        f = fopen(pwdName, "r");
                    352:        if (!f) {
                    353:                LOGERR;
                    354:                return -1;
                    355:        }
                    356: 
                    357:        ret = cfgReadPasswd(f, pwd);
                    358: 
                    359:        fclose(f);
                    360:        return ret;
                    361: }
                    362: 
                    363: /*
                    364:  * cfgClearPasswd() - Clear passwords and free resources
                    365:  *
                    366:  * @cfg = Password root
                    367:  * return: none
                    368:  */
                    369: void
                    370: cfgClearPasswd(pwd_root_t * __restrict pwd)
                    371: {
                    372:        struct tagUser *p;
                    373: 
                    374:        if (!pwd)
                    375:                return;
                    376: 
                    377:        PWD_LOCK(pwd);
                    378:        while ((p = SLIST_FIRST(pwd))) {
                    379:                SLIST_REMOVE_HEAD(pwd, usr_next);
                    380: 
                    381:                AIT_FREE_VAL(&p->usr_name);
                    382:                AIT_FREE_VAL(&p->usr_pass);
                    383:                AIT_FREE_VAL(&p->usr_uid);
                    384:                AIT_FREE_VAL(&p->usr_gid);
                    385:                AIT_FREE_VAL(&p->usr_class);
                    386:                AIT_FREE_VAL(&p->usr_change);
                    387:                AIT_FREE_VAL(&p->usr_expire);
                    388:                AIT_FREE_VAL(&p->usr_realm);
                    389:                AIT_FREE_VAL(&p->usr_home);
                    390:                AIT_FREE_VAL(&p->usr_shell);
1.9       misho     391:                e_free(p);
1.8       misho     392:        }
                    393:        pwd->rbh_root = NULL;
                    394:        PWD_UNLOCK(pwd);
                    395: }
                    396: 
                    397: /*
                    398:  * cfgUnloadPasswd() - Unload passwords from memory and destroy resources
                    399:  *
                    400:  * @pwd = Password root
                    401:  * return: none
                    402:  */
                    403: void
                    404: cfgUnloadPasswd(pwd_root_t * __restrict pwd)
                    405: {
                    406:        if (!pwd)
                    407:                return;
                    408: 
                    409:        cfgClearPasswd(pwd);
                    410:        pthread_mutex_destroy(&pwd->pwd_mtx);
                    411: }
                    412: 
                    413: /*
                    414:  * cfgCreatePasswd() - Create password file from memory
                    415:  *
                    416:  * @pwdName = New password filename
                    417:  * @pwd = Password root
                    418:  * return: -1 error or 0 ok
                    419:  */
                    420: int
                    421: cfgCreatePasswd(const char *pwdName, pwd_root_t * __restrict pwd)
                    422: {
                    423:        FILE *f;
                    424:        int ret;
                    425: 
                    426:        if (!pwdName || !pwd)
                    427:                return -1;
                    428: 
                    429:        f = fopen(pwdName, "w");
                    430:        if (!f) {
                    431:                LOGERR;
                    432:                return -1;
                    433:        }
                    434:        
                    435:        ret = cfgWritePasswd(f, pwd);
                    436: 
                    437:        fclose(f);
                    438:        return ret;
                    439: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>