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

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.16.6.3! misho       6: * $Id: aitcfg.c,v 1.16.6.2 2025/08/19 11:06:32 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.16.6.1  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.16.6.1  misho     160:  * cfgInitConfigExt() - Init existed config root
                    161:  *
                    162:  * @cfg = Config root
                    163:  * return: NULL error or !=NULL inited config root
                    164:  */
                    165: cfg_root_t *
                    166: cfgInitConfigExt(cfg_root_t * __restrict cfg)
                    167: {
1.16.6.2  misho     168:        pthread_mutex_t mtx = { 0 };
                    169: 
                    170:        if (!TAILQ_EMPTY(cfg) || !RB_EMPTY(cfg) ||
                    171:                        memcmp(&cfg->rc_mtx, &mtx, sizeof mtx))
1.16.6.1  misho     172:                cfgUnloadConfig(cfg);
                    173: 
                    174:        memset(cfg, 0, sizeof(cfg_root_t));
                    175: 
                    176:        pthread_mutex_init(&cfg->rc_mtx, NULL);
                    177: 
                    178:        TAILQ_INIT(cfg);
                    179:        RB_INIT(cfg);
                    180:        return cfg;
                    181: }
                    182: 
                    183: /*
1.5       misho     184:  * cfgLoadConfig() - Load config from file
                    185:  *
                    186:  * @cfgName = Config filename
                    187:  * @cfg = Config root
                    188:  * return: -1 error or 0 ok
                    189:  */
                    190: int
                    191: cfgLoadConfig(const char *cfgName, cfg_root_t * __restrict cfg)
1.1       misho     192: {
                    193:        FILE *f;
                    194:        int ret;
1.16.6.2  misho     195:        pthread_mutex_t mtx = { 0 };
1.1       misho     196: 
1.5       misho     197:        if (!cfgName || !cfg) {
                    198:                cfg_SetErr(EINVAL, "Invalid parameter(s)");
1.1       misho     199:                return -1;
1.12      misho     200:        } else {
1.16.6.3! misho     201:                if (!TAILQ_EMPTY(cfg) || !RB_EMPTY(cfg) || memcmp(&cfg->rc_mtx, &mtx, sizeof mtx))
1.16.6.1  misho     202:                        cfgUnloadConfig(cfg);
1.16.6.3! misho     203:                /*
        !           204:                if (memcmp(&cfg->rc_mtx, &mtx, sizeof mtx))
        !           205:                        pthread_mutex_destroy(&cfg->rc_mtx);
        !           206:                        */
1.16.6.1  misho     207: 
1.15      misho     208:                memset(cfg, 0, sizeof(cfg_root_t));
                    209: 
1.12      misho     210:                pthread_mutex_init(&cfg->rc_mtx, NULL);
                    211: 
                    212:                TAILQ_INIT(cfg);
                    213:                RB_INIT(cfg);
                    214:        }
1.1       misho     215: 
1.5       misho     216:        f = fopen(cfgName, "r");
                    217:        if (!f) {
1.1       misho     218:                LOGERR;
                    219:                return -1;
                    220:        }
                    221: 
1.5       misho     222:        ret = cfgReadConfig(f, cfg);
1.1       misho     223: 
                    224:        fclose(f);
                    225:        return ret;
                    226: }
                    227: 
                    228: /*
1.7       misho     229:  * cfgClearConfig() - Clear config and free resources
1.5       misho     230:  *
                    231:  * @cfg = Config root
                    232:  * return: none
                    233:  */
                    234: void
1.7       misho     235: cfgClearConfig(cfg_root_t * __restrict cfg)
1.1       misho     236: {
1.5       misho     237:        struct tagCfg *av;
1.1       misho     238: 
1.5       misho     239:        if (!cfg)
1.1       misho     240:                return;
                    241: 
1.5       misho     242:        CFG_RC_LOCK(cfg);
1.11      misho     243:        while ((av = TAILQ_FIRST(cfg))) {
                    244:                TAILQ_REMOVE(cfg, av, cfg_next);
1.5       misho     245: 
                    246:                AIT_FREE_VAL(&av->cfg_val);
                    247:                AIT_FREE_VAL(&av->cfg_attr);
                    248:                AIT_FREE_VAL(&av->cfg_sec);
1.9       misho     249:                e_free(av);
1.1       misho     250:        }
1.5       misho     251:        cfg->rbh_root = NULL;
                    252:        CFG_RC_UNLOCK(cfg);
1.7       misho     253: }
                    254: 
                    255: /*
                    256:  * cfgUnloadConfig() - Unload config from memory and destroy resources
                    257:  *
                    258:  * @cfg = Config root
                    259:  * return: none
                    260:  */
                    261: void
                    262: cfgUnloadConfig(cfg_root_t * __restrict cfg)
                    263: {
                    264:        if (!cfg)
                    265:                return;
1.1       misho     266: 
1.7       misho     267:        cfgClearConfig(cfg);
1.5       misho     268:        pthread_mutex_destroy(&cfg->rc_mtx);
1.16.6.3! misho     269:        memset(&cfg->rc_mtx, 0, sizeof cfg->rc_mtx);
1.1       misho     270: }
                    271: 
1.3       misho     272: /*
1.5       misho     273:  * cfgCreateConfig() - Create config file from memory
                    274:  *
1.3       misho     275:  * @csConfigName = New config filename
1.5       misho     276:  * @cfg = Config root
                    277:  * @whitespace = Additional whitespace characters to file
                    278:  * return: -1 error or 0 ok
                    279:  */
                    280: int
                    281: cfgCreateConfig(const char *csConfigName, cfg_root_t * __restrict cfg, int whitespace)
1.3       misho     282: {
                    283:        FILE *f;
                    284:        int ret;
                    285: 
                    286:        if (!csConfigName || !cfg)
                    287:                return -1;
                    288: 
1.5       misho     289:        f = fopen(csConfigName, "w");
1.3       misho     290:        if (!f) {
                    291:                LOGERR;
                    292:                return -1;
                    293:        }
                    294:        
1.16      misho     295:        ret = cfgWriteConfigRaw(f, cfg, whitespace);
1.3       misho     296: 
                    297:        fclose(f);
                    298:        return ret;
                    299: }
1.8       misho     300: 
                    301: /*
                    302:  * cfgInitPasswd() - Init password root
                    303:  *
1.12      misho     304:  * return: NULL error or !=NULL allocated password root
1.8       misho     305:  */
1.12      misho     306: pwd_root_t *
                    307: cfgInitPasswd()
1.8       misho     308: {
1.12      misho     309:        pwd_root_t *pwd = NULL;
                    310: 
                    311:        pwd = e_malloc(sizeof(pwd_root_t));
                    312:        if (!pwd) {
                    313:                cfg_SetErr(elwix_GetErrno(), "%s", elwix_GetError());
                    314:                return NULL;
                    315:        } else
                    316:                memset(pwd, 0, sizeof(pwd_root_t));
1.8       misho     317: 
                    318:        pthread_mutex_init(&pwd->pwd_mtx, NULL);
                    319: 
                    320:        SLIST_INIT(pwd);
                    321:        RB_INIT(pwd);
                    322:        return 0;
                    323: }
                    324: 
                    325: /*
1.12      misho     326:  * cfgEndPasswd() - Free resources & password root
                    327:  *
                    328:  * @ppwd = Password root
                    329:  * return: none
                    330:  */
                    331: void
                    332: cfgEndPasswd(pwd_root_t **ppwd)
                    333: {
                    334:        if (ppwd && *ppwd) {
                    335:                cfgClearPasswd(*ppwd);
                    336:                pthread_mutex_destroy(&(*ppwd)->pwd_mtx);
                    337:                e_free(*ppwd);
                    338:                *ppwd = NULL;
                    339:        }
                    340: }
                    341: 
                    342: /*
1.8       misho     343:  * cfgLoadPasswd() - Load passwords from file
                    344:  *
                    345:  * @pwdName = Passwords filename
                    346:  * @pwd = Password root
                    347:  * return: -1 error or 0 ok
                    348:  */
                    349: int
                    350: cfgLoadPasswd(const char *pwdName, pwd_root_t * __restrict pwd)
                    351: {
                    352:        FILE *f;
                    353:        int ret;
                    354: 
                    355:        if (!pwdName || !pwd) {
                    356:                cfg_SetErr(EINVAL, "Invalid parameter(s)");
                    357:                return -1;
1.12      misho     358:        } else {
1.15      misho     359:                memset(pwd, 0, sizeof(pwd_root_t));
                    360: 
1.12      misho     361:                pthread_mutex_init(&pwd->pwd_mtx, NULL);
                    362: 
                    363:                SLIST_INIT(pwd);
                    364:                RB_INIT(pwd);
                    365:        }
1.8       misho     366: 
                    367:        f = fopen(pwdName, "r");
                    368:        if (!f) {
                    369:                LOGERR;
                    370:                return -1;
                    371:        }
                    372: 
                    373:        ret = cfgReadPasswd(f, pwd);
                    374: 
                    375:        fclose(f);
                    376:        return ret;
                    377: }
                    378: 
                    379: /*
                    380:  * cfgClearPasswd() - Clear passwords and free resources
                    381:  *
                    382:  * @cfg = Password root
                    383:  * return: none
                    384:  */
                    385: void
                    386: cfgClearPasswd(pwd_root_t * __restrict pwd)
                    387: {
                    388:        struct tagUser *p;
                    389: 
                    390:        if (!pwd)
                    391:                return;
                    392: 
                    393:        PWD_LOCK(pwd);
                    394:        while ((p = SLIST_FIRST(pwd))) {
                    395:                SLIST_REMOVE_HEAD(pwd, usr_next);
                    396: 
                    397:                AIT_FREE_VAL(&p->usr_name);
                    398:                AIT_FREE_VAL(&p->usr_pass);
                    399:                AIT_FREE_VAL(&p->usr_uid);
                    400:                AIT_FREE_VAL(&p->usr_gid);
                    401:                AIT_FREE_VAL(&p->usr_class);
                    402:                AIT_FREE_VAL(&p->usr_change);
                    403:                AIT_FREE_VAL(&p->usr_expire);
                    404:                AIT_FREE_VAL(&p->usr_realm);
                    405:                AIT_FREE_VAL(&p->usr_home);
                    406:                AIT_FREE_VAL(&p->usr_shell);
1.9       misho     407:                e_free(p);
1.8       misho     408:        }
                    409:        pwd->rbh_root = NULL;
                    410:        PWD_UNLOCK(pwd);
                    411: }
                    412: 
                    413: /*
                    414:  * cfgUnloadPasswd() - Unload passwords from memory and destroy resources
                    415:  *
                    416:  * @pwd = Password root
                    417:  * return: none
                    418:  */
                    419: void
                    420: cfgUnloadPasswd(pwd_root_t * __restrict pwd)
                    421: {
                    422:        if (!pwd)
                    423:                return;
                    424: 
                    425:        cfgClearPasswd(pwd);
                    426:        pthread_mutex_destroy(&pwd->pwd_mtx);
                    427: }
                    428: 
                    429: /*
                    430:  * cfgCreatePasswd() - Create password file from memory
                    431:  *
                    432:  * @pwdName = New password filename
                    433:  * @pwd = Password root
                    434:  * return: -1 error or 0 ok
                    435:  */
                    436: int
                    437: cfgCreatePasswd(const char *pwdName, pwd_root_t * __restrict pwd)
                    438: {
                    439:        FILE *f;
                    440:        int ret;
                    441: 
                    442:        if (!pwdName || !pwd)
                    443:                return -1;
                    444: 
                    445:        f = fopen(pwdName, "w");
                    446:        if (!f) {
                    447:                LOGERR;
                    448:                return -1;
                    449:        }
                    450:        
                    451:        ret = cfgWritePasswd(f, pwd);
                    452: 
                    453:        fclose(f);
                    454:        return ret;
                    455: }

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