Debian Codegraph @

share/libc/pwd.h

raw
1 /**************************************************************************/
2 /* */
3 /* This file is part of Frama-C. */
4 /* */
5 /* Copyright (C) 2007-2022 */
6 /* CEA (Commissariat à l'énergie atomique et aux énergies */
7 /* alternatives) */
8 /* */
9 /* you can redistribute it and/or modify it under the terms of the GNU */
10 /* Lesser General Public License as published by the Free Software */
11 /* Foundation, version 2.1. */
12 /* */
13 /* It is distributed in the hope that it will be useful, */
14 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
15 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
16 /* GNU Lesser General Public License for more details. */
17 /* */
18 /* See the GNU Lesser General Public License version 2.1 */
19 /* for more details (enclosed in the file licenses/LGPLv2.1). */
20 /* */
21 /**************************************************************************/
22
23 #ifndef __FC_PWD_H__
24 #define __FC_PWD_H__
25 #include "features.h"
26 __PUSH_FC_STDLIB
27
28 #include "__fc_builtin.h"
29 #include "__fc_define_uid_and_gid.h"
30 #include "__fc_string_axiomatic.h"
31
32 #include "errno.h"
33 // for size_t
34 #include "stddef.h"
35 __BEGIN_DECLS
36
37 struct passwd {
38 char *pw_name;
39 char *pw_passwd; // not POSIX, but allowed by it, and present in glibc
40 uid_t pw_uid;
41 gid_t pw_gid;
42 char *pw_gecos; // not POSIX, but present in most implementations
43 char *pw_dir;
44 char *pw_shell;
45 };
46
47 __FC_EXTERN char __fc_getpw_pw_name[64];
48 __FC_EXTERN char __fc_getpw_pw_passwd[64];
49 __FC_EXTERN char __fc_getpw_pw_gecos[64];
50 __FC_EXTERN char __fc_getpw_pw_dir[64];
51 __FC_EXTERN char __fc_getpw_pw_shell[64];
52
53 struct passwd __fc_pwd =
54 {.pw_name = __fc_getpw_pw_name,
55 .pw_passwd = __fc_getpw_pw_passwd,
56 .pw_gecos = __fc_getpw_pw_gecos,
57 .pw_dir = __fc_getpw_pw_dir,
58 .pw_shell = __fc_getpw_pw_shell};
59
60 struct passwd *__fc_p_pwd = & __fc_pwd;
61
62 /*@
63 // missing: may assign to errno: EIO, EINTR, EMFILE, ENFILE
64 // missing: assigns \result, __fc_pwd[0..] \from 'password database'
65 requires valid_name: valid_read_string(name);
66 assigns \result \from __fc_p_pwd, indirect:name[0..];
67 assigns __fc_pwd \from indirect:name[0..];
68 ensures result_null_or_internal_struct:
69 \result == \null || \result == __fc_p_pwd;
70 */
71 extern struct passwd *getpwnam(const char *name);
72
73 /*@ // missing: assigns \result, __fc_pwd[0..] \from 'password database'
74 assigns \result \from __fc_p_pwd, indirect:uid;
75 assigns __fc_pwd \from indirect:uid;
76 ensures result_null_or_internal_struct:
77 \result == \null || \result == __fc_p_pwd;
78 */
79 extern struct passwd *getpwuid(uid_t uid);
80
81 /*@
82 // missing: assigns \result, *result, *pwd, __fc_pwd[0..] \from 'password database'
83 requires valid_name: valid_read_string(name);
84 requires valid_buf: \valid(buf+(0 .. buflen-1));
85 requires valid_pwd: \valid(pwd);
86 requires valid_result: \valid(result);
87 assigns \result \from indirect:__fc_p_pwd, indirect:name[0..];
88 assigns __fc_pwd \from indirect:name[0..];
89 assigns *pwd, *result \from __fc_p_pwd;
90 assigns buf[0 .. buflen-1] \from indirect:*__fc_p_pwd;
91 ensures result_null_or_assigned:
92 *result == \null || *result == pwd;
93 ensures result_ok_or_error:
94 \result == 0 || \result \in {EIO, EMFILE, ENFILE, ERANGE};
95 */
96 extern int getpwnam_r(const char *name, struct passwd *pwd,
97 char *buf, size_t buflen, struct passwd **result);
98
99 /*@
100 // missing: assigns \result, *result, *pwd, __fc_pwd[0..] \from 'password database'
101 requires valid_buf: \valid(buf+(0 .. buflen-1));
102 requires valid_pwd: \valid(pwd);
103 requires valid_result: \valid(result);
104 assigns \result \from indirect:__fc_p_pwd;
105 assigns __fc_pwd \from indirect:uid;
106 assigns *pwd, *result \from __fc_p_pwd;
107 assigns buf[0 .. buflen-1] \from indirect:*__fc_p_pwd;
108 ensures result_null_or_assigned:
109 *result == \null || *result == pwd;
110 ensures result_ok_or_error:
111 \result == 0 || \result \in {EIO, EMFILE, ENFILE, ERANGE};
112 */
113 extern int getpwuid_r(uid_t uid, struct passwd *pwd,
114 char *buf, size_t buflen, struct passwd **result);
115
116 extern void endpwent(void);
117 extern struct passwd *getpwent(void);
118 extern void setpwent(void);
119
120 __END_DECLS
121
122 __POP_FC_STDLIB
123 #endif