/usr/lib/python2.7/dist-packages/nss_cache/caches/nssdb.py is in nsscache 0.33-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 | # Copyright 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""An implementation of nss_db local cache for nsscache."""
__author__ = 'jaq@google.com (Jamie Wilkinson)'
import bsddb
import fcntl
import os
import select
import subprocess
from nss_cache import config
from nss_cache import error
from nss_cache.caches import caches
from nss_cache.maps import group
from nss_cache.maps import passwd
from nss_cache.maps import shadow
def RegisterAllImplementations(register_callback):
"""Register our cache classes independently from the import scheme."""
register_callback('nssdb', 'passwd', NssDbPasswdHandler)
register_callback('nssdb', 'group', NssDbGroupHandler)
register_callback('nssdb', 'shadow', NssDbShadowHandler)
class NssDbCache(caches.Cache):
"""An implementation of a Cache specific to nss_db.
nss_db uses one Berkeley DB database per map for the cache. This class
abstracts the update and write strategies for nss_db caches.
This class also provides timestamp read/write routines that are
independent of the cache storage, as nss_db provides no support for
these.
"""
UPDATE_TIMESTAMP_SUFFIX = 'nsscache-update-timestamp'
MODIFY_TIMESTAMP_SUFFIX = 'nsscache-timestamp'
def __init__(self, conf, map_name, automount_mountpoint=None):
"""Create a handler for the given map type.
Args:
conf: a configuration object
map_name: a string representing the type of map we are
automount_mountpoint: A string containing the automount mountpoint,
used only by automount maps.
Returns: A CacheMapHandler instance.
"""
super(NssDbCache, self).__init__(conf, map_name,
automount_mountpoint=automount_mountpoint)
self.makedb = conf.get('makedb', '/usr/bin/makedb')
def GetMap(self, cache_filename=None):
"""Returns the map from the cache.
Args:
cache_filename: unused by this implementation of caches.Cache
Returns:
a Map containing the map cache
"""
data = self.data
self._LoadBdbCacheFile(data)
return data
def _LoadBdbCacheFile(self, data):
"""Load data from bdb caches into a map.
Args:
data: a map.Map subclass
Returns:
Nothing. Cache data is loaded into the 'data' parameter.
Raises:
CacheNotFound: if the database file does not exist
"""
db_file = os.path.join(self.output_dir, self.CACHE_FILENAME)
if not os.path.exists(db_file):
self.log.debug('cache file does not exist: %r', db_file)
raise error.CacheNotFound('cache file does not exist: %r' % db_file)
db = bsddb.btopen(db_file, 'r')
for k in db:
if self.IsMapPrimaryKey(k):
password_entry = self.ConvertValueToMapEntry(db[k])
if not data.Add(password_entry):
self.log.warn('could not add entry built from %r', db[k])
db.close()
def _SpawnMakeDb(self):
"""Run 'makedb' in a subprocess and return it to use for streaming.
Returns:
a subprocess object
"""
# TODO(jaq): this should probably raise a better exception and be handled
# gracefully
if not os.path.exists(self.makedb):
self.log.warn('makedb binary %s does not exist, cannot generate bdb map',
self.makedb)
return None
else:
self.log.debug('executing makedb: %s - %s',
self.makedb, self.temp_cache_filename)
# This is a race condition on the tempfile now, but db-4.8 is braindead
# and refuses to open zero length files with:
# fop_read_meta: foo: unexpected file type or format
# foo: Invalid type 5 specified
# makedb: cannot open output file `foo': Invalid argument
os.unlink(self.temp_cache_filename)
makedb = subprocess.Popen([self.makedb, '-', self.temp_cache_filename],
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
close_fds=True)
fcntl.fcntl(makedb.stdout, fcntl.F_SETFL, os.O_NONBLOCK)
makedb.allout = ""
return makedb
def _Read(self, proc):
while len(select.select([proc.stdout],(),(),0)[0]) > 0:
data = proc.stdout.read()
if len(data) == 0: break # sigh... select() says there's data.
proc.allout += data
def Write(self, map_data):
"""Write the map to the cache file.
Warning -- this destroys map_data as it is written. This is done to save
memory and keep our peak footprint smaller. We consume memory again
on Verify() as we read a new copy of the entries back in.
Args:
map_data: A Map subclass
Returns:
a set of keys written or None on failure.
"""
self._Begin()
written_keys = set()
self.log.debug('Map contains %d elems', len(map_data))
enumeration_index = 0
makedb = self._SpawnMakeDb()
self.makedbproc = makedb
try:
try:
while True:
entry = map_data.PopItem()
if makedb:
self._Read(makedb)
if makedb.poll() is not None:
self.log.error('early exit from makedb! child output: %s',
makedb.allout)
# in this case, no matter how the child exited, we complain
return None
self.WriteData(makedb.stdin, entry, enumeration_index)
else:
self.WriteData(None, entry, enumeration_index)
written_keys.update(self.ExpectedKeysForEntry(entry))
enumeration_index += 1
except KeyError:
# expected when PopItem() is done, and breaks our loop for us.
pass
if makedb: makedb.stdin.close()
self.log.debug('%d entries written, %d keys', enumeration_index,
len(written_keys))
# wait for subprocess to commit data before we move live.
if makedb:
makedb.wait()
self._Read(makedb)
makedb.stdout.close()
map_data = makedb.allout
if map_data:
self.log.debug('makedb output: %r', map_data)
if self._DecodeExitCode(makedb.wait()):
return written_keys
return None
else:
return written_keys
except Exception as e:
self.log.debug('Wrote %d entries before exception %s', enumeration_index, e)
if makedb:
self.log.debug('makedb output: %s', makedb.allout)
# wait for subprocess to commit data before we roll back.
makedb.wait()
self._Rollback()
raise
def _DecodeExitCode(self, code):
"""Helper function to compute if a child exited with code 0 or not."""
return os.WIFEXITED(code) and (os.WEXITSTATUS(code) is 0)
# TODO(jaq): validate the unit tests for this code path, are we
# verifying the temp cache or the real cache?
def Verify(self, written_keys):
"""Verify that the written cache is correct.
Perform some unit tests on the written data, such as reading it
back and verifying that it loads and has the entries we expect.
Args:
written_keys: a set of keys that should have been written to disk.
Returns:
boolean indicating success.
Raises:
EmptyMap: The cache being verified is empty.
"""
self.log.debug('verification started %s', self.temp_cache_filename)
db = bsddb.btopen(self.temp_cache_filename, 'r')
# cast keys to a set for fast __contains__ lookup in the loop
# following
cache_keys = set(db)
db.close()
written_key_count = len(written_keys)
cache_key_count = len(cache_keys)
self.log.debug('%d written keys, %d cache keys', written_key_count,
cache_key_count)
if cache_key_count <= 0 and written_key_count > 0:
# We have an empty db, yet we expect that earlier we should have
# written more. Uncaught disk full or other error?
raise error.EmptyMap
# makedb creates new keys internally. we only care that all the keys
# we tried to write out are still there. so written_keys must be a subset
# of cache_keys!
if not written_keys.issubset(cache_keys):
self.log.warn('verify failed: written keys missing from the on-disk'
' cache!')
intersection = written_keys.intersection(cache_keys)
missing_keys = written_keys - intersection
self.log.debug('missing: %r', missing_keys)
self._Rollback()
return False
self.log.info('verify passed: %s', self.temp_cache_filename)
return True
class NssDbPasswdHandler(NssDbCache):
"""Concrete class for updating a nss_db passwd cache."""
CACHE_FILENAME = 'passwd.db'
def __init__(self, conf, map_name=None, automount_mountpoint=None):
if map_name is None: map_name = config.MAP_PASSWORD
super(NssDbPasswdHandler, self).__init__(
conf, map_name, automount_mountpoint=automount_mountpoint)
def WriteData(self, target, entry, enumeration_index):
"""Generate three entries as expected by nss_db passwd map.
nss_db keys each pwent on three keys: username, uid number, and an
enumeration index. This method writes the pwent out three times
to the target file-like object with each of these keys, each marked
specially as documented in the nss_db source db-Makefile.
Args:
target: File-like object of the makedb subprocess stdin
entry: A PasswdMapEntry
enumeration_index: The number of records processed so far.
Returns:
Nothing
"""
password_entry = '%s:%s:%d:%d:%s:%s:%s' % (entry.name, entry.passwd,
entry.uid, entry.gid,
entry.gecos, entry.dir,
entry.shell)
# Write to makedb with each key
if target:
target.write('.%s %s\n' % (entry.name, password_entry))
target.write('=%d %s\n' % (entry.uid, password_entry))
target.write('0%d %s\n' % (enumeration_index, password_entry))
def IsMapPrimaryKey(self, key):
"""Defines the 'primary' key for this map.
nss_db maps typically have the same entry many times in their cache
files. In order to build our representation of the cache, we need to
ignore all but one of them. This method chooses one key as the primary.
Args:
key: the database key returned from the Berkeley DB key/value pairs
Returns:
a boolean indicating truth
"""
# only take values keyed with username, known in nss_db land as the
# one starting with a dot
return key.startswith('.')
def ConvertValueToMapEntry(self, entry):
"""Convert a pwent-like string into a PasswdMapEntry.
Args:
entry: A string containing a pwent entry ala /etc/passwd
Returns:
a PasswdMapEntry instance
"""
if entry.endswith('\x00'):
entry = entry[:-1]
entry = entry.split(':')
map_entry = passwd.PasswdMapEntry()
# maps expect strict typing, so convert to int as appropriate.
map_entry.name = entry[0]
map_entry.passwd = entry[1]
map_entry.uid = int(entry[2])
map_entry.gid = int(entry[3])
map_entry.gecos = entry[4]
map_entry.dir = entry[5]
map_entry.shell = entry[6]
return map_entry
def ExpectedKeysForEntry(self, entry):
"""Generate a list of expected cache keys for this entry.
Args:
entry: A PasswdMapEntry
Returns:
a list of strings
"""
return ['.%s' % entry.name,
'=%d' % entry.uid]
class NssDbGroupHandler(NssDbCache):
"""Concrete class for updating nss_db group maps."""
CACHE_FILENAME = 'group.db'
def __init__(self, conf, map_name=None, automount_mountpoint=None):
if map_name is None: map_name = config.MAP_GROUP
super(NssDbGroupHandler, self).__init__(
conf, map_name, automount_mountpoint=automount_mountpoint)
def WriteData(self, target, entry, enumeration_index):
"""Generate three entries as expected by nss_db group map.
nss_db keys each grent on three keys: group name, gid number, and an
enumeration index. This method writes the grent out three times
to the target file-like object with each of these keys, each marked
specially as documented in the nss_db source db-Makefile.
Args:
target: File-like object of the makedb subprocess stdin
entry: A GroupMapEntry
enumeration_index: The number of records processed so far.
Returns:
Nothing
"""
grent = '%s:%s:%d:%s' % (entry.name, entry.passwd, entry.gid,
','.join(entry.members))
# Write to makedb with each key
if target:
target.write('.%s %s\n' % (entry.name, grent))
target.write('=%d %s\n' % (entry.gid, grent))
target.write('0%d %s\n' % (enumeration_index, grent))
def IsMapPrimaryKey(self, key):
"""Defines the 'primary' key for a nss_db group.db map.
See the docstring for NssDbPasswdCache.IsMapPrimaryKey()
Args:
key: they database key returned from bsddb.
Returns:
a boolean indicating truth
"""
# use the key designated as a 'group name' key
return key.startswith('.')
def ConvertValueToMapEntry(self, entry):
"""Convert a grent-like string into a GroupMapEntry.
Args:
entry: A string containing a grent entry ala /etc/group
Returns:
A GroupMapEntry instance
"""
if entry.endswith('\x00'):
entry = entry[:-1]
entry = entry.split(':')
map_entry = group.GroupMapEntry()
# map entries expect strict typing, so convert as appropriate
map_entry.name = entry[0]
map_entry.passwd = entry[1]
map_entry.gid = int(entry[2])
map_entry.members = entry[3].split(',')
return map_entry
def ExpectedKeysForEntry(self, entry):
"""Generate a list of expected cache keys for this entry.
Args:
entry: A GroupMapEntry
Returns:
a list of strings
"""
return ['.%s' % entry.name,
'=%d' % entry.gid]
class NssDbShadowHandler(NssDbCache):
"""Concrete class for updating nss_db shadow maps."""
CACHE_FILENAME = 'shadow.db'
def __init__(self, conf, map_name=None, automount_mountpoint=None):
if map_name is None: map_name = config.MAP_SHADOW
super(NssDbShadowHandler, self).__init__(
conf, map_name, automount_mountpoint=automount_mountpoint)
def WriteData(self, target, entry, enumeration_index):
"""Generate three entries as expected by nss_db shadow map.
nss_db keys each shadow entry on two keys, username and enumeration
index.
This method writes out the shadow entry twice, once with each key,
each marked specially as documented in the nss_db source db-Makefile.
Args:
target: File-like object of the makedb subprocess stdin
entry: A ShadowMapEntry
enumeration_index: The number of records processed so far.
Returns:
Nothing
"""
# If the field is None, then set to empty string
shadow_entry = '%s:%s:%s:%s:%s:%s:%s:%s:%s' % (entry.name,
entry.passwd,
entry.lstchg or '',
entry.min or '',
entry.max or '',
entry.warn or '',
entry.inact or '',
entry.expire or '',
entry.flag or 0)
# Write to makedb with each key
if target:
target.write('.%s %s\n' % (entry.name, shadow_entry))
target.write('0%d %s\n' % (enumeration_index, shadow_entry))
def IsMapPrimaryKey(self, key):
"""Defines the 'primary' key for a nss_db shadow.db map.
See the docstring for NssDbPasswdCache.IsMapPrimaryKey()
Args:
key: they database key returned from bsddb.
Returns:
a boolean indicating truth
"""
# use the key designated as a "shadow name" key
return key.startswith('.')
def ConvertValueToMapEntry(self, entry):
"""Convert a grent-like string into a ShadowMapEntry.
Args:
entry: A string containing a grent entry ala /etc/shadow
Returns:
A ShadowMapEntry instance
"""
if entry.endswith('\x00'):
entry = entry[:-1]
entry = entry.split(':')
map_entry = shadow.ShadowMapEntry()
# map entries expect strict typing, so convert as appropriate
map_entry.name = entry[0]
map_entry.passwd = entry[1]
if entry[2]:
map_entry.lstchg = int(entry[2])
if entry[3]:
map_entry.min = int(entry[3])
if entry[4]:
map_entry.max = int(entry[4])
if entry[5]:
map_entry.warn = int(entry[5])
if entry[6]:
map_entry.inact = int(entry[6])
if entry[7]:
map_entry.expire = int(entry[7])
if entry[8]:
map_entry.flag = int(entry[8])
return map_entry
def ExpectedKeysForEntry(self, entry):
"""Generate a list of expected cache keys for this entry.
Args:
entry: A ShadowMapEntry
Returns:
a list of strings
"""
return ['.%s' % entry.name]
|