lib/commonio.h

   1 /*
   2  * Copyright (c) 1990 - 1994, Julianne Frances Haugh
   3  * Copyright (c) 1996 - 2000, Marek Michałkiewicz
   4  * Copyright (c) 2001 - 2005, Tomasz Kłoczko
   5  * Copyright (c) 2007 - 2008, Nicolas François
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. The name of the copyright holders or contributors may not be used to
  17  *    endorse or promote products derived from this software without
  18  *    specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
  24  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 /* $Id: commonio.h 2806 2009-04-25 14:16:22Z nekral-guest $ */
  34 #ifndef _COMMONIO_H
  35 #define _COMMONIO_H
  36
  37 #ifdef WITH_SELINUX
  38 #include <selinux/selinux.h>
  39 #endif
  40
  41 #include "defines.h" /* bool */
  42
  43 /*
  44  * Linked list entry.
  45  */
  46 struct commonio_entry {
  47         /*@null@*/char *line;
  48         /*@null@*/void *eptr;           /* struct passwd, struct spwd, ... */
  49         /*@dependent@*/ /*@null@*/struct commonio_entry *prev;
  50         /*@owned@*/ /*@null@*/struct commonio_entry *next;
  51         bool changed:1;
  52 };
  53
  54 /*
  55  * Operations depending on database type: passwd, group, shadow etc.
  56  */
  57 struct commonio_ops {
  58         /*
  59          * Make a copy of the object (for example, struct passwd)
  60          * and all strings pointed by it, in malloced memory.
  61          */
  62         /*@null@*/ /*@only@*/void *(*dup) (const void *);
  63
  64         /*
  65          * free() the object including any strings pointed by it.
  66          */
  67         void (*free) (/*@out@*/ /*@only@*/void *);
  68
  69         /*
  70          * Return the name of the object (for example, pw_name
  71          * for struct passwd).
  72          */
  73         const char *(*getname) (const void *);
  74
  75         /*
  76          * Parse a string, return object (in static area -
  77          * should be copied using the dup operation above).
  78          */
  79         void *(*parse) (const char *);
  80
  81         /*
  82          * Write the object to the file (this calls putpwent()
  83          * for struct passwd, for example).
  84          */
  85         int (*put) (const void *, FILE *);
  86
  87         /*
  88          * fgets and fputs (can be replaced by versions that
  89          * understand line continuation conventions).
  90          */
  91         /*@null@*/char *(*fgets) (/*@returned@*/ /*@out@*/char *s, int n, FILE *stream);
  92         int (*fputs) (const char *, FILE *);
  93
  94         /*
  95          * open_hook and close_hook.
  96          * If non NULL, these functions will be called after the database
  97          * is open or before it is closed.
  98          * They return 0 on failure and 1 on success.
  99          */
 100         /*@null@*/int (*open_hook) (void);
 101         /*@null@*/int (*close_hook) (void);
 102 };
 103
 104 /*
 105  * Database structure.
 106  */
 107 struct commonio_db {
 108         /*
 109          * Name of the data file.
 110          */
 111         char filename[1024];
 112
 113         /*
 114          * Operations from above.
 115          */
 116         /*@observer@*/const struct commonio_ops *ops;
 117
 118         /*
 119          * Currently open file stream.
 120          */
 121         /*@dependent@*/ /*@null@*/FILE *fp;
 122
 123 #ifdef WITH_SELINUX
 124         /*@null@*/security_context_t scontext;
 125 #endif
 126         /*
 127          * Head, tail, current position in linked list.
 128          */
 129         /*@owned@*/ /*@null@*/struct commonio_entry *head, *tail;
 130         /*@dependent@*/ /*@null@*/struct commonio_entry *cursor;
 131
 132         /*
 133          * Various flags.
 134          */
 135         bool changed:1;
 136         bool isopen:1;
 137         bool locked:1;
 138         bool readonly:1;
 139 };
 140
 141 extern int commonio_setname (struct commonio_db *, const char *);
 142 extern bool commonio_present (const struct commonio_db *db);
 143 extern int commonio_lock (struct commonio_db *);
 144 extern int commonio_lock_nowait (struct commonio_db *);
 145 extern int commonio_open (struct commonio_db *, int);
 146 extern /*@observer@*/ /*@null@*/const void *commonio_locate (struct commonio_db *, const char *);
 147 extern int commonio_update (struct commonio_db *, const void *);
 148 extern int commonio_remove (struct commonio_db *, const char *);
 149 extern int commonio_rewind (struct commonio_db *);
 150 extern /*@observer@*/ /*@null@*/const void *commonio_next (struct commonio_db *);
 151 extern int commonio_close (struct commonio_db *);
 152 extern int commonio_unlock (struct commonio_db *);
 153 extern void commonio_del_entry (struct commonio_db *,
 154                                 const struct commonio_entry *);
 155 extern int commonio_sort_wrt (struct commonio_db *shadow,
 156                               struct commonio_db *passwd);
 157 extern int commonio_sort (struct commonio_db *db,
 158                           int (*cmp) (const void *, const void *));
 159
 160 #endif