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

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

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