source: trunk/include/slib.h@ 248

Last change on this file since 248 was 248, checked in by katerina, 15 years ago

Code to track down originating site for ticket #163.
File size: 16.1 KB
RevLine 
[1]1/* --------------------------------------------------------------
2 *
3 * The developement of this library has been stimulated by reading
4 * a paper on 'Robust Programming' by Matt Bishop, although
5 * not all of his ideas might be implemented in the same
6 * strictness as discussed in the paper.
7 *
8 * --------------------------------------------------------------
9 */
10
11#ifndef SL_SLIB_H
12#define SL_SLIB_H
13
14#include <errno.h>
15#include <stdio.h>
16#include <stdlib.h>
17#include <stdarg.h>
18#include <sys/types.h>
19
20#include "config_xor.h"
21
22#ifdef HAVE_UNISTD_H
23#include <unistd.h>
24#endif
25
[167]26#include "sh_string.h"
27
[1]28/****************
29
30 -- Defined in config.h. --
31
32 #ifndef _(string)
33 #define _(string) string
34 #endif
35
36 #ifndef N_(string)
37 #define N_(string) string
38 #endif
39
40*****************/
41
42/* --------------------------------------------------------------
43 *
44 * Typedefs, global variables, macros.
45 *
46 * --------------------------------------------------------------
47 */
48
49extern long int sl_errno; /* Global error variable. */
50
51
52/* The ticketing system; used to hide internals from the
53 * programmer.
54 */
55typedef long int SL_TICKET; /* Unique ID for opened files. */
56
57
58/*
59 * TRUE, FALSE
60 */
61#define SL_TRUE 1
62#define SL_FALSE 0
63
[138]64#define SH_GRBUF_SIZE 4096
65#define SH_PWBUF_SIZE 4096
[1]66
67
[149]68#if defined(__GNUC__) && (__GNUC__ >= 3)
69#undef SL_GNUC_CONST
70#define SL_GNUC_CONST __attribute__((const))
71#else
[156]72#undef SL_GNUC_CONST
73#define SL_GNUC_CONST
[149]74#endif
75
[1]76/*
77 * The following macros are provided:
78 *
79 * SL_ISERROR(x) TRUE if return status of 'x' is an error code.
80 * SL_REQUIRE(x, xstr) Abort if 'x' is false.
81 * SL_ENTER(s) Trace entry in function 's'.
82 * SL_RETURN(x, s) Trace return from function 's'.
83 */
84
85
86/*
87 * The error codes.
88 */
89#define SL_ENONE 0
90
91#define SL_ENULL -1024 /* Invalid use of NULL pointer. */
92#define SL_ERANGE -1025 /* Argument out of range. */
93#define SL_ETRUNC -1026 /* Result truncated. */
94#define SL_EREPEAT -1027 /* Illegal repeated use of function. */
95
96#define SL_EINTERNAL -1028 /* Internal error. */
97#define SL_ETICKET -1029 /* Bad ticket. */
98#define SL_EBADFILE -1030 /* File access error. Check errno. */
99#define SL_EBOGUS -1031 /* Bogus file. */
100#define SL_EMEM -1032 /* Out of memory. */
101#define SL_EUNLINK -1033 /* Unlink error. Check errno. */
102#define SL_EREWIND -1034 /* Rewind error. Check errno. */
103#define SL_EFORWARD -1035 /* Forward error. Check errno. */
104#define SL_EREAD -1036 /* Read error. Check errno. */
105#define SL_EWRITE -1037 /* Write error. Check errno. */
106#define SL_ESYNC -1038 /* Write error. Check errno. */
107
108#define SL_EBADNAME -1040 /* Invalid name. */
109#define SL_ESTAT -1041 /* stat of file failed. Check errno. */
[192]110#define SL_EFSTAT -1042 /* fstat of file failed. Check errno. */
[1]111
112#define SL_EBADUID -1050 /* Owner not trustworthy. */
113#define SL_EBADGID -1051 /* Group writeable and not trustworthy.*/
114#define SL_EBADOTH -1052 /* World writeable. */
115
116#define SL_TOOMANY -1053 /* Too many open files */
117#define SL_TIMEOUT -1054 /* Timeout in read */
[192]118
119#define SL_EISDIR -1055 /* Is a directory */
[243]120
121#define SL_EINTERNAL01 -1061 /* Internal error. */
122#define SL_EINTERNAL02 -1062 /* Internal error. */
123#define SL_EINTERNAL03 -1063 /* Internal error. */
124#define SL_EINTERNAL04 -1064 /* Internal error. */
125#define SL_EINTERNAL05 -1065 /* Internal error. */
126#define SL_EINTERNAL06 -1066 /* Internal error. */
127#define SL_EINTERNAL07 -1067 /* Internal error. */
128#define SL_EINTERNAL08 -1068 /* Internal error. */
129#define SL_EINTERNAL09 -1069 /* Internal error. */
130#define SL_EINTERNAL10 -1070 /* Internal error. */
131#define SL_EINTERNAL11 -1071 /* Internal error. */
132#define SL_EINTERNAL12 -1072 /* Internal error. */
133
[1]134/*
135 * All int functions return SL_NONE on success.
136 */
137
138#ifdef __cplusplus
139extern "C" {
140#endif
141
[170]142 int dlog (int flag, const char * file, int line, const char *fmt, ...);
[1]143
[170]144 char * sl_get_errmsg(void);
[1]145
146 /* ----------------------------------------------------------------
147 *
148 * Heap consistency routines
149 *
150 * ---------------------------------------------------------------- */
151
[170]152 int sl_test_heap(void);
[1]153
154 /* ----------------------------------------------------------------
155 *
156 * Capability routines
157 *
158 * ---------------------------------------------------------------- */
159
160 extern int sl_useCaps;
161
[170]162 int sl_drop_cap (void);
163 int sl_drop_cap_sub(void);
164 int sl_get_cap_sub(void);
165 int sl_drop_cap_qdel(void);
166 int sl_get_cap_qdel(void);
[1]167
168 /* ----------------------------------------------------------------
169 *
170 * String handling routines
171 *
172 * ---------------------------------------------------------------- */
173
174 /*
175 * A memset that does not get optimized away
176 */
177 void *sl_memset(void *s, int c, size_t n);
[11]178#if !defined(SH_REAL_SET)
[1]179#undef memset
180#define memset sl_memset
[11]181#endif
[1]182
183 /*
184 * Copy src to dst. siz is the length of dst.
185 */
186 int sl_strlcpy(char * dst, /*@null@*/const char * src, size_t siz);
187
188 /*
189 * Append src to dst. siz is the length of dst.
190 */
191 int sl_strlcat(char * dst, /*@null@*/const char *src, size_t siz);
192
193 /*
194 * An implementation of vsnprintf. va_start/va_end are in the caller
195 * function.
196 */
197 int sl_vsnprintf(char *str, size_t n,
198 const char *format, va_list vl );
199
200 /*
201 * An implementation of snprintf.
202 */
203 int sl_snprintf(char *str, size_t n,
204 const char *format, ... );
205
206 /*
207 * A robust drop-in replacement of strncpy. strlcpy is preferable.
208 */
209 char * sl_strncpy(/*@out@*/char *dst, const char *src, size_t size);
210
211 /*
212 * Robust strncat.
213 */
214 char * sl_strncat(char *dst, const char *src, size_t n);
215
216 /*
217 * strstr
218 */
[214]219 char * sl_strstr (const char * haystack, const char * needle);
[1]220
221 /*
222 * robust strncmp replacement
223 */
224 int sl_strncmp(const char * a, const char * b, size_t n);
225
226 /*
227 * robust strcmp replacement
228 */
229 int sl_strcmp(const char * a, const char * b);
230
231 /*
[169]232 * robust strcasecmp replacement
233 */
234 int sl_strcasecmp(const char * one, const char * two);
235
236 /*
[1]237 * robust strlen replacement
238 */
239#define sl_strlen(arg) ((arg == NULL) ? 0 : (strlen(arg)))
240
241 /* ----------------------------------------------------------------
242 *
243 * Privilege handling routines
244 *
245 * ---------------------------------------------------------------- */
246
247 /*
248 * ONE OF THE FOLLOWING THREE FUNCTIONS
249 * SHOULD BE CALLED BEFORE ANY OTHER OF THE
250 * UID HANDLING FUNCTIONS.
251 */
[170]252 int sl_policy_get_user(const char *username); /* drop SUID to <username> */
[1]253 int sl_policy_get_real(char *username); /* drop privs to <username> */
254 int sl_policy_get_root(void); /* drop SUID to root */
255
256 /*
257 * If not using one of the above, use this function,
258 * and then call sh_unset_suid().
259 * This function saves the uid's.
260 * It calls abort() on error.
261 */
262 int sl_save_uids(void);
263
264 /*
265 * This function returns the saved euid.
266 * It calls abort() if the uid's are not saved already.
267 */
268 int sl_get_euid(/*@out@*/uid_t * ret);
[170]269 uid_t sl_ret_euid(void);
[1]270
271 /*
272 * This function returns the saved egid.
273 * It calls abort() if the uid's are not saved already.
274 */
275 int sl_get_egid(/*@out@*/gid_t * ret);
276
277 /*
278 * This function returns the saved current ruid.
279 * It calls abort() if the uid's are not saved already.
280 */
281 int sl_get_ruid(/*@out@*/uid_t * ret);
282
283 /*
284 * This function returns the saved current rgid.
285 * It calls abort() if the uid's are not saved already.
286 */
287 int sl_get_rgid(gid_t * ret);
288
289 /*
290 * This function returns the saved original ruid.
291 * It calls abort() if the uid's are not saved already.
292 */
293 int sl_get_ruid_orig(uid_t * ret);
294
295 /*
296 * This function returns the saved original rgid.
297 * It calls abort() if the uid's are not saved already.
298 */
299 int sl_get_rgid_orig(gid_t * ret);
300
301 /*
302 * This function returns true if the program is SUID.
303 * It calls abort() if the uid's are not saved already.
304 */
305 int sl_is_suid(void);
306
307 /*
308 * This function sets the effective uid
309 * to the saved effective uid.
310 */
311 int sl_set_suid (void);
312
313 /*
314 * This function sets the effective uid to the real uid.
315 */
316 int sl_unset_suid (void);
317
318 /*
319 * This function drops SUID privileges irrevocably.
320 */
321 int sl_drop_privileges(void);
322
323 /* ----------------------------------------------------------------
324 *
325 * File handling routines
326 *
327 * ---------------------------------------------------------------- */
328
[248]329#define SL_OFILE_SIZE 32
[1]330
[248]331 char * sl_check_stale();
332
333 SL_TICKET sl_make_ticket (const char * ofile, int oline,
334 int fd, const char * filename);
335
[1]336 /* Open for writing.
337 */
[248]338 SL_TICKET sl_open_write (const char * ofile, int oline,
339 const char * fname, int priviledge_mode);
[1]340
341 /* Open for reading.
342 */
[248]343 SL_TICKET sl_open_read (const char * ofile, int oline,
344 const char * fname, int priviledge_mode);
[1]345
[196]346 /* Drop from cach when closing
347 */
348 int sl_set_drop_cache(const char * str);
349
[1]350 /* Open for reading w/minimum checking.
351 */
[248]352 SL_TICKET sl_open_fastread (const char * ofile, int oline,
353 const char * fname, int priviledge_mode);
[1]354
355 /* Open for read and write.
356 */
[248]357 SL_TICKET sl_open_rdwr (const char * ofile, int oline,
358 const char * fname, int priviledge_mode);
[1]359
360 /* Open for read and write, fail if file exists.
361 */
[248]362 SL_TICKET sl_open_safe_rdwr (const char * ofile, int oline,
363 const char * fname, int priv);
[1]364
365 /* Open for write, truncate.
366 */
[248]367 SL_TICKET sl_open_write_trunc (const char * ofile, int oline,
368 const char * fname, int priviledge_mode);
[1]369
370 /* Open for read and write, truncate.
371 */
[248]372 SL_TICKET sl_open_rdwr_trunc (const char * ofile, int oline,
373 const char * fname, int priviledge_mode);
[1]374
[167]375 /* Initialize the content sh_string.
376 */
377 int sl_init_content (SL_TICKET ticket, size_t size);
378
379 /* Get the (pointer to) the content sh_string.
380 */
381 sh_string * sl_get_content (SL_TICKET ticket);
382
[212]383 /* Lock file (uses fcntl F_SETLK).
384 */
385 int sl_lock (SL_TICKET ticket);
386
[1]387 /* Close file.
388 */
389 int sl_close (SL_TICKET ticket);
390
391 /* Unlink file.
392 */
393 int sl_unlink (SL_TICKET ticket);
394
395 /* Rewind file.
396 */
397 int sl_rewind (SL_TICKET ticket);
398
399 /* Seek file.
400 */
401 int sl_seek (SL_TICKET ticket, off_t off_data);
402
403 /* Forward file.
404 */
405 int sl_forward (SL_TICKET ticket);
406
407 /* Sync file.
408 */
409 int sl_sync (SL_TICKET ticket);
410
411 /* Read file.
412 */
413 int sl_read (SL_TICKET ticket, void * buf, size_t count);
414
[8]415 int sl_read_timeout_prep (SL_TICKET ticket);
416
[131]417 int sl_read_timeout_fd (int fd, void * buf,
418 size_t count, int timeout, int is_nonblocking);
419
[1]420 int sl_read_timeout (SL_TICKET ticket, void * buf,
[131]421 size_t count, int timeout, int is_nonblocking);
[1]422
423 int sl_read_fast (SL_TICKET ticket, void * buf_in, size_t count);
424
425 /* Write file.
426 */
[170]427 int sl_write (SL_TICKET ticket, const void * msg, long nbytes);
[1]428
429 /* Write file, terminate with newline.
430 */
[170]431 int sl_write_line (SL_TICKET ticket, const void * msg, long nbytes);
[1]432
[76]433 /* As above, but only for non-constant strings.
434 */
435 int sl_write_line_fast (SL_TICKET ticket, void * msg, long nbytes);
436
[1]437 /* Drop all metadata for file descriptors >= fd.
438 */
439 int sl_dropall(int fd, int except);
[174]440 int sl_dropall_dirty(int fd, int except); /* don't deallocate */
[1]441
442 /* Check whether file is trustworthy.
443 */
[183]444 int sl_trustfile(const char * path, uid_t * ok, uid_t * bad);
[1]445
446 /* Check whether file is trustworthy.
447 */
[183]448 int sl_trustfile_euid(const char * filename, uid_t euid);
[1]449
450 /* purge list of trusted users
451 */
[170]452 int sl_trust_purge_user (void);
[1]453
454 /* Add a trusted user.
455 */
456 int sl_trust_add_user (uid_t pwid);
457
458 /* Get error string.
459 */
460 char * sl_error_string(int errorcode);
461
462 /* Get error file.
463 */
464 char * sl_trust_errfile(void);
465
[20]466 /* Overflow tests
467 */
[149]468 int sl_ok_muli (int a, int b) SL_GNUC_CONST;
469 int sl_ok_divi (int a, int b) SL_GNUC_CONST;
470 int sl_ok_addi (int a, int b) SL_GNUC_CONST;
471 int sl_ok_subi (int a, int b) SL_GNUC_CONST;
[1]472
[149]473 int sl_ok_muls (size_t a, size_t b) SL_GNUC_CONST;
474 int sl_ok_adds (size_t a, size_t b) SL_GNUC_CONST;
[34]475
476
[1]477#ifdef __cplusplus
478}
479#endif
480
481/* Privilege modes for file access.
482 */
483#define SL_YESPRIV 0x33
484#define SL_NOPRIV 0x34
485
[76]486/* Suitable for Linux
487 */
488#define MAXFILENAME 4096
[1]489
490
491/*
492 * This macro is TRUE if (x) < 0.
493 */
494#define SL_ISERROR(x) ((long)(x) < 0)
495
496#if defined(WITH_TPT)
497#define TPT(arg) dlog arg ;
498#else
499#define TPT(arg)
500#endif
501
502
503/*
504 * The 'require' macro.
505 */
506#define SL_REQUIRE(assertion, astext) \
507do { \
508 /*@i@*/ if (assertion) ; \
509 else { \
510 dlog(0, FIL__, __LINE__, SDG_AFAIL, \
511 FIL__, __LINE__, astext); \
512 _exit(EXIT_FAILURE); \
513 } \
514} while (0)
515
516
517/*
518 * The enter macro. Prints the trace if TRACE is on.
519 */
520extern int slib_do_trace;
521extern int slib_trace_fd;
522
523#if defined(SL_DEBUG)
524#define SL_ENTER(s) sl_stack_push(s, FIL__, __LINE__);
525#else
526#define SL_ENTER(s) if (slib_do_trace != 0) sl_trace_in(s, FIL__, __LINE__);
527#endif
528
529/*
530 * The return macro.
531 */
532#if defined(SL_DEBUG)
533#ifndef S_SPLINT_S
534#define SL_RETURN(x, s) \
535do { \
536 sl_stack_pop(s, FIL__, __LINE__); \
537 return(x); \
538} while(0)
539#else
540/*@notfunction@*/
541#define SL_RETURN(x, s) return(x);
542#endif /* S_SPLINT_S */
543#else
544#ifndef S_SPLINT_S
545#define SL_RETURN(x, s) \
546do { \
547 if (slib_do_trace != 0) \
548 sl_trace_out(s, FIL__, __LINE__); \
549 return(x); \
550} while(0)
551#else
552/*@notfunction@*/
553#define SL_RETURN(x, s) return(x);
554#endif /* S_SPLINT_S */
555#endif /* SL_RETURN macro */
556
557#if defined(SL_DEBUG)
558#define SL_RET0(s) \
559do { \
560 sl_stack_pop(s, FIL__, __LINE__); \
561 return; \
562} while(0)
563#else
564#ifndef S_SPLINT_S
565#define SL_RET0(s) \
566do { \
567 if (slib_do_trace != 0) \
568 sl_trace_out(s, FIL__, __LINE__); \
569 return; \
570} while(0)
571#else
572/*@notfunction@*/
573#define SL_RET0(s) return;
574#endif /* S_SPLINT_S */
575#endif /* SL_RETURN macro */
576
577#if defined(SL_DEBUG)
578void sl_stack_push(char * c, char * file, int line);
579void sl_stack_pop(char * c, char * file, int line);
[170]580void sl_stack_print(void);
[1]581#endif
[170]582void sl_trace_in (const char * str, const char * file, int line);
583void sl_trace_out (const char * str, const char * file, int line);
[20]584int sl_trace_file (const char * str);
585int sl_trace_use (const char * str);
[1]586
587
588
589
590/*
591 * The internal return macro. Sets sl_errno to the return value.
592 */
593
594#if defined(SL_DEBUG)
595#define SL_IRETURN(x, s) \
596do { \
597 if((long)(x) < 0) { \
598 TPT((0, FIL__, __LINE__, SDG_ERROR, (long)(x))) \
599 sl_errno=(x); \
600 } \
601 sl_stack_pop(s, FIL__, __LINE__); \
602 if (1) return(x); \
603} while(0)
604#else
605#define SL_IRETURN(x, s) \
606do { \
607 if ((long)(x) < 0) sl_errno=(x); \
608 if (slib_do_trace) \
609 sl_trace_out(s, FIL__, __LINE__); \
610 if (1) return(x); \
611} while(0)
612
613#endif /* SL_IRETURN macro */
614
615
616
617/* slib.h */
618#endif
619
620
621
622
Note: See TracBrowser for help on using the repository browser.