1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import datetime
from testinfra.modules.base import Module
class User(Module):
"""Test unix users
If name is not supplied, test the current user
"""
def __init__(self, name=None):
self._name = name
super().__init__()
@property
def name(self):
"""Return user name"""
if self._name is None:
self._name = self.check_output("id -nu")
return self._name
@property
def exists(self):
"""Test if user exists
>>> host.user("root").exists
True
>>> host.user("nosuchuser").exists
False
"""
return self.run_test("id %s", self.name).rc == 0
@property
def uid(self):
"""Return user ID"""
return int(self.check_output("id -u %s", self.name))
@property
def gid(self):
"""Return effective group ID"""
return int(self.check_output("id -g %s", self.name))
@property
def group(self):
"""Return effective group name"""
return self.check_output("id -ng %s", self.name)
@property
def gids(self):
"""Return the list of user group IDs"""
return [
int(gid)
for gid in self.check_output(
"id -G %s",
self.name,
).split(" ")
]
@property
def groups(self):
"""Return the list of user group names"""
return self.check_output("id -nG %s", self.name).split(" ")
@property
def home(self):
"""Return the user home directory"""
return self.check_output("getent passwd %s", self.name).split(":")[5]
@property
def shell(self):
"""Return the user login shell"""
return self.check_output("getent passwd %s", self.name).split(":")[6]
@property
def password(self):
"""Return the encrypted user password"""
return self.check_output("getent shadow %s", self.name).split(":")[1]
@property
def password_max_days(self):
"""Return the maximum number of days between password changes"""
days = self.check_output("getent shadow %s", self.name).split(":")[4]
try:
return int(days)
except ValueError:
return None
@property
def password_min_days(self):
"""Return the minimum number of days between password changes"""
days = self.check_output("getent shadow %s", self.name).split(":")[3]
try:
return int(days)
except ValueError:
return None
@property
def gecos(self):
"""Return the user comment/gecos field"""
return self.check_output("getent passwd %s", self.name).split(":")[4]
@property
def expiration_date(self):
"""Return the account expiration date
>>> host.user("phil").expiration_date
datetime.datetime(2020, 1, 1, 0, 0)
>>> host.user("root").expiration_date
None
"""
days = self.check_output("getent shadow %s", self.name).split(":")[7]
try:
days = int(days)
except ValueError:
return None
if days > 0:
epoch = datetime.datetime.utcfromtimestamp(0)
return epoch + datetime.timedelta(days=int(days))
@property
def get_all_users(self):
"""Returns a list of local and remote user names
>>> host.user().get_all_users
["root", "bin", "daemon", "lp", <...>]
"""
all_users = [
line.split(":")[0]
for line in self.check_output("getent passwd").splitlines()
]
return all_users
@property
def get_local_users(self):
"""Returns a list of local user names
>>> host.user().get_local_users
["root", "bin", "daemon", "lp", <...>]
"""
local_users = [
line.split(":")[0]
for line in self.check_output("cat /etc/passwd").splitlines()
]
# strip NIS compat mode entries
local_users = [i for i in local_users if not i.startswith("+")]
return local_users
@classmethod
def get_module_class(cls, host):
if host.system_info.type.endswith("bsd"):
return BSDUser
if host.system_info.type == "windows":
return WindowsUser
return super().get_module_class(host)
def __repr__(self):
return f"<user {self.name}>"
class BSDUser(User):
@property
def password(self):
return self.check_output("getent passwd %s", self.name).split(":")[1]
@property
def expiration_date(self):
seconds = self.check_output("getent passwd %s", self.name).split(":")[6]
try:
seconds = int(seconds)
except ValueError:
return None
if seconds > 0:
epoch = datetime.datetime.utcfromtimestamp(0)
return epoch + datetime.timedelta(seconds=int(seconds))
class WindowsUser(User):
@property
def name(self):
"""Return user name"""
if self._name is None:
self._name = self.check_output("echo %username%")
return self._name
@property
def exists(self):
"""Test if user exists
>>> host.user("Administrator").exists
True
>>> host.user("nosuchuser").exists
False
"""
return self.run_test("net user %s", self.name).rc == 0
@property
def uid(self):
raise NotImplementedError
@property
def gid(self):
raise NotImplementedError
@property
def group(self):
raise NotImplementedError
@property
def gids(self):
raise NotImplementedError
@property
def groups(self):
"""Return the list of user local group names"""
local_groups = self.check_output(
'net user %s | findstr /B /C:"Local Group Memberships"', self.name
)
local_groups = local_groups.split()[3:]
return [g.replace("*", "") for g in local_groups]
@property
def home(self):
raise NotImplementedError
@property
def shell(self):
raise NotImplementedError
@property
def gecos(self):
comment = self.check_output('net user %s | find /B /C:"Comment"', self.name)
return comment.split().strip()[1]
@property
def password(self):
raise NotImplementedError
@property
def expiration_date(self):
expiration = self.check_output(
'net user %s | findstr /B /C:"Password \
expires"',
self.name,
)
expiration = expiration.split().strip()[1]
if expiration == "Never":
return None
return datetime.datetime.strptime(expiration, "%m/%d/%Y %H:%M%S %p")
|