annotate liboctave/system/oct-passwd.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
1 /*
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
2
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 Copyright (C) 1996-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
7
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
8
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
9 This file is part of Octave.
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
10
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23615
diff changeset
11 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
12 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23615
diff changeset
13 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
14 (at your option) any later version.
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
15
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
19 GNU General Public License for more details.
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
20
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
21 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6108
diff changeset
22 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23615
diff changeset
23 <https://www.gnu.org/licenses/>.
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
24
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
25 */
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
26
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 #if ! defined (octave_oct_passwd_h)
17822
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents: 17744
diff changeset
28 #define octave_oct_passwd_h 1
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
29
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21102
diff changeset
30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21102
diff changeset
31
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
32 #include <string>
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
33
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
34 #include <sys/types.h>
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
35
21734
11af9c03400c write namespace keyword and name on same line in C++ files
John W. Eaton <jwe@octave.org>
parents: 21729
diff changeset
36 namespace octave
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
37 {
21734
11af9c03400c write namespace keyword and name on same line in C++ files
John W. Eaton <jwe@octave.org>
parents: 21729
diff changeset
38 namespace sys
2937
9d26524e2869 [project @ 1997-05-06 05:49:53 by jwe]
jwe
parents: 2934
diff changeset
39 {
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
40 class
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
41 OCTAVE_API
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
42 password
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
43 {
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
44 public:
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
45
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
46 password (void)
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
47 : m_name (), m_passwd (), m_uid (0), m_gid (0), m_gecos (),
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
48 m_dir (), m_shell (), valid (false)
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
49 { }
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
50
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
51 password (const password& pw)
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
52 : m_name (pw.m_name), m_passwd (pw.m_passwd),
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
53 m_uid (pw.m_uid), m_gid (pw.m_gid), m_gecos (pw.m_gecos),
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
54 m_dir (pw.m_dir), m_shell (pw.m_shell), valid (pw.valid)
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
55 { }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
56
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
57 password& operator = (const password& pw)
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
58 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
59 if (this != &pw)
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
60 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
61 m_name = pw.m_name;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
62 m_passwd = pw.m_passwd;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
63 m_uid = pw.m_uid;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
64 m_gid = pw.m_gid;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
65 m_gecos = pw.m_gecos;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
66 m_dir = pw.m_dir;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
67 m_shell = pw.m_shell;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
68 valid = pw.valid;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
69 }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
70
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
71 return *this;
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
72 }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
73
22868
87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors
John W. Eaton <jwe@octave.org>
parents: 22755
diff changeset
74 ~password (void) = default;
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
75
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
76 std::string name (void) const;
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
77
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
78 std::string passwd (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
79
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
80 uid_t uid (void) const;
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
81
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
82 gid_t gid (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
83
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
84 std::string gecos (void) const;
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
85
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
86 std::string dir (void) const;
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
87
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
88 std::string shell (void) const;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
89
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
90 bool ok (void) const { return valid; }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
91
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
92 operator bool () const { return ok (); }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
93
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
94 static password getpwent (void);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
95 static password getpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
96
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
97 static password getpwuid (uid_t uid);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
98 static password getpwuid (uid_t uid, std::string& msg);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
99
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
100 static password getpwnam (const std::string& nm);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
101 static password getpwnam (const std::string& nm, std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
102
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
103 static int setpwent (void);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
104 static int setpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
105
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
106 static int endpwent (void);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
107 static int endpwent (std::string& msg);
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
108
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
109 private:
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
110
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
111 // User name.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
112 std::string m_name;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
113
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
114 // Encrypted password.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
115 std::string m_passwd;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
116
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
117 // Numeric user id.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
118 uid_t m_uid;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
119
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
120 // Numeric group id.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
121 gid_t m_gid;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
122
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
123 // Miscellaneous junk.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
124 std::string m_gecos;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
125
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
126 // Home directory.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
127 std::string m_dir;
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
128
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
129 // Login shell.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
130 std::string m_shell;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
131
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
132 // Flag that says whether we have been properly initialized.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
133 bool valid;
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
134
21729
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
135 // This is how we will create a password object from a pointer
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
136 // to a struct passwd.
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
137 password (void *p, std::string& msg);
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
138 };
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
139 }
815b2f500fab use namespace for system password wrapper class
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
140 }
2934
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
141
dddc1b5c324e [project @ 1997-05-05 22:56:37 by jwe]
jwe
parents:
diff changeset
142 #endif