/usr/lib/python2.7/dist-packages/Bcfg2/Server/Encryption.py is in bcfg2-server 1.4.0~pre2+git141-g6d40dace6358-1.
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 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 | """ Bcfg2.Server.Encryption provides a number of convenience methods
for handling encryption in Bcfg2. See :ref:`server-encryption` for
more details. """
import os
import sys
import copy
import logging
import lxml.etree
import Bcfg2.Logger
import Bcfg2.Options
from M2Crypto import Rand
from M2Crypto.EVP import Cipher, EVPError
from Bcfg2.Utils import safe_input
from Bcfg2.Server import XMLParser
from Bcfg2.Compat import md5, b64encode, b64decode, StringIO
#: Constant representing the encryption operation for
#: :class:`M2Crypto.EVP.Cipher`, which uses a simple integer. This
#: makes our code more readable.
ENCRYPT = 1
#: Constant representing the decryption operation for
#: :class:`M2Crypto.EVP.Cipher`, which uses a simple integer. This
#: makes our code more readable.
DECRYPT = 0
#: Default initialization vector. For best security, you should use a
#: unique IV for each message. :func:`ssl_encrypt` does this in an
#: automated fashion.
IV = r'\0' * 16
class _OptionContainer(object):
""" Container for options loaded at import-time to configure
encryption """
options = [
Bcfg2.Options.BooleanOption(
cf=("encryption", "lax_decryption"),
help="Decryption failures should cause warnings, not errors"),
Bcfg2.Options.Option(
cf=("encryption", "algorithm"), default="aes_256_cbc",
type=lambda v: v.lower().replace("-", "_"),
help="The encryption algorithm to use"),
Bcfg2.Options.Option(
cf=("encryption", "*"), dest='passphrases', default=dict(),
help="Encryption passphrases")]
Bcfg2.Options.get_parser().add_component(_OptionContainer)
Rand.rand_seed(os.urandom(1024))
def _cipher_filter(cipher, instr):
""" M2Crypto reads and writes file-like objects, so this uses
StringIO to pass data through it """
inbuf = StringIO(instr)
outbuf = StringIO()
while 1:
buf = inbuf.read()
if not buf:
break
outbuf.write(cipher.update(buf))
outbuf.write(cipher.final())
rv = outbuf.getvalue()
inbuf.close()
outbuf.close()
return rv
def str_encrypt(plaintext, key, iv=IV, algorithm=None, salt=None):
""" Encrypt a string with a key. For a higher-level encryption
interface, see :func:`ssl_encrypt`.
:param plaintext: The plaintext data to encrypt
:type plaintext: string
:param key: The key to encrypt the data with
:type key: string
:param iv: The initialization vector
:type iv: string
:param algorithm: The cipher algorithm to use
:type algorithm: string
:param salt: The salt to use
:type salt: string
:returns: string - The decrypted data
"""
if algorithm is None:
algorithm = Bcfg2.Options.setup.algorithm
cipher = Cipher(alg=algorithm, key=key, iv=iv, op=ENCRYPT, salt=salt)
return _cipher_filter(cipher, plaintext)
def str_decrypt(crypted, key, iv=IV, algorithm=None):
""" Decrypt a string with a key. For a higher-level decryption
interface, see :func:`ssl_decrypt`.
:param crypted: The raw binary encrypted data
:type crypted: string
:param key: The encryption key to decrypt with
:type key: string
:param iv: The initialization vector
:type iv: string
:param algorithm: The cipher algorithm to use
:type algorithm: string
:returns: string - The decrypted data
"""
if algorithm is None:
algorithm = Bcfg2.Options.setup.algorithm
cipher = Cipher(alg=algorithm, key=key, iv=iv, op=DECRYPT)
return _cipher_filter(cipher, crypted)
def ssl_decrypt(data, passwd, algorithm=None):
""" Decrypt openssl-encrypted data. This can decrypt data
encrypted by :func:`ssl_encrypt`, or ``openssl enc``. It performs
a base64 decode first if the data is base64 encoded, and
automatically determines the salt and initialization vector (both
of which are embedded in the encrypted data).
:param data: The encrypted data (either base64-encoded or raw
binary) to decrypt
:type data: string
:param passwd: The password to use to decrypt the data
:type passwd: string
:param algorithm: The cipher algorithm to use
:type algorithm: string
:returns: string - The decrypted data
"""
# base64-decode the data
data = b64decode(data)
salt = data[8:16]
# pylint: disable=E1101,E1121
hashes = [md5(passwd + salt).digest()]
for i in range(1, 3):
hashes.append(md5(hashes[i - 1] + passwd + salt).digest())
# pylint: enable=E1101,E1121
key = hashes[0] + hashes[1]
iv = hashes[2]
return str_decrypt(data[16:], key=key, iv=iv, algorithm=algorithm)
def ssl_encrypt(plaintext, passwd, algorithm=None, salt=None):
""" Encrypt data in a format that is openssl compatible.
:param plaintext: The plaintext data to encrypt
:type plaintext: string
:param passwd: The password to use to encrypt the data
:type passwd: string
:param algorithm: The cipher algorithm to use
:type algorithm: string
:param salt: The salt to use. If none is provided, one will be
randomly generated.
:type salt: bytes
:returns: string - The base64-encoded, salted, encrypted string.
The string includes a trailing newline to make it fully
compatible with openssl command-line tools.
"""
if salt is None:
salt = Rand.rand_bytes(8)
# pylint: disable=E1101,E1121
hashes = [md5(passwd + salt).digest()]
for i in range(1, 3):
hashes.append(md5(hashes[i - 1] + passwd + salt).digest())
# pylint: enable=E1101,E1121
key = hashes[0] + hashes[1]
iv = hashes[2]
crypted = str_encrypt(plaintext, key=key, salt=salt, iv=iv,
algorithm=algorithm)
return b64encode("Salted__" + salt + crypted) + "\n"
def is_encrypted(val):
""" Make a best guess if the value is encrypted or not. This just
checks to see if ``val`` is a base64-encoded string whose content
starts with "Salted\\_\\_", so it may have (rare) false positives. It
will not have false negatives. """
try:
return b64decode(val).startswith("Salted__")
except: # pylint: disable=W0702
return False
def bruteforce_decrypt(crypted, passphrases=None, algorithm=None):
""" Convenience method to decrypt the given encrypted string by
trying the given passphrases or all passphrases sequentially until
one is found that works.
:param crypted: The data to decrypt
:type crypted: string
:param passphrases: The passphrases to try.
:type passphrases: list
:param algorithm: The cipher algorithm to use
:type algorithm: string
:returns: string - The decrypted data
:raises: :class:`M2Crypto.EVP.EVPError`, if the data cannot be decrypted
"""
if passphrases is None:
passphrases = Bcfg2.Options.setup.passphrases.values()
for passwd in passphrases:
try:
return ssl_decrypt(crypted, passwd, algorithm=algorithm)
except EVPError:
pass
raise EVPError("Failed to decrypt")
def print_xml(element, keep_text=False):
""" Render an XML element for error output. This prefixes the
line number and removes children for nicer display.
:param element: The element to render
:type element: lxml.etree._Element
:param keep_text: Do not discard text content from the element for
display
:type keep_text: boolean
"""
xml = None
if len(element) or element.text:
el = copy.copy(element)
if el.text and not keep_text:
el.text = '...'
for child in el.iterchildren():
el.remove(child)
xml = lxml.etree.tostring(
el,
xml_declaration=False).decode("UTF-8").strip()
else:
xml = lxml.etree.tostring(
element,
xml_declaration=False).decode("UTF-8").strip()
return "%s (line %s)" % (xml, element.sourceline)
class PassphraseError(Exception):
""" Exception raised when there's a problem determining the
passphrase to encrypt or decrypt with """
class DecryptError(Exception):
""" Exception raised when decryption fails. """
class EncryptError(Exception):
""" Exception raised when encryption fails. """
class CryptoTool(object):
""" Generic decryption/encryption interface base object """
def __init__(self, filename):
self.logger = logging.getLogger(self.__class__.__name__)
self.filename = filename
self.data = open(self.filename).read()
self.pname, self.passphrase = self._get_passphrase()
def _get_passphrase(self):
""" get the passphrase for the current file """
if not Bcfg2.Options.setup.passphrases:
raise PassphraseError("No passphrases available in %s" %
Bcfg2.Options.setup.config)
pname = None
if Bcfg2.Options.setup.passphrase:
pname = Bcfg2.Options.setup.passphrase
if pname:
try:
passphrase = Bcfg2.Options.setup.passphrases[pname]
self.logger.debug("Using passphrase %s specified on command "
"line" % pname)
return (pname, passphrase)
except KeyError:
raise PassphraseError("Could not find passphrase %s in %s" %
(pname, Bcfg2.Options.setup.config))
else:
if len(Bcfg2.Options.setup.passphrases) == 1:
pname, passphrase = Bcfg2.Options.setup.passphrases.items()[0]
self.logger.info("Using passphrase %s" % pname)
return (pname, passphrase)
elif len(Bcfg2.Options.setup.passphrases) > 1:
return (None, None)
raise PassphraseError("No passphrase could be determined")
def get_destination_filename(self, original_filename):
""" Get the filename where data should be written """
return original_filename
def write(self, data):
""" write data to disk """
new_fname = self.get_destination_filename(self.filename)
try:
self._write(new_fname, data)
self.logger.info("Wrote data to %s" % new_fname)
return True
except IOError:
err = sys.exc_info()[1]
self.logger.error("Error writing data from %s to %s: %s" %
(self.filename, new_fname, err))
return False
def _write(self, filename, data):
""" Perform the actual write of data. This is separate from
:func:`CryptoTool.write` so it can be easily
overridden. """
open(filename, "wb").write(data)
class Decryptor(CryptoTool):
""" Decryptor interface """
def decrypt(self):
""" decrypt the file, returning the encrypted data """
raise NotImplementedError
class Encryptor(CryptoTool):
""" encryptor interface """
def encrypt(self):
""" encrypt the file, returning the encrypted data """
raise NotImplementedError
class CfgEncryptor(Encryptor):
""" encryptor class for Cfg files """
def __init__(self, filename):
Encryptor.__init__(self, filename)
if self.passphrase is None:
raise PassphraseError("Multiple passphrases found in %s, "
"specify one on the command line with -p" %
Bcfg2.Options.setup.config)
def encrypt(self):
if is_encrypted(self.data):
raise EncryptError("Data is alraedy encrypted")
return ssl_encrypt(self.data, self.passphrase)
def get_destination_filename(self, original_filename):
return original_filename + ".crypt"
class CfgDecryptor(Decryptor):
""" Decrypt Cfg files """
def decrypt(self):
""" decrypt the given file, returning the plaintext data """
if self.passphrase:
try:
return ssl_decrypt(self.data, self.passphrase)
except EVPError:
raise DecryptError("Could not decrypt %s with the "
"specified passphrase" % self.filename)
except:
raise DecryptError("Error decrypting %s: %s" %
(self.filename, sys.exc_info()[1]))
else: # no passphrase given, brute force
try:
return bruteforce_decrypt(self.data)
except EVPError:
raise DecryptError("Could not decrypt %s with any passphrase" %
self.filename)
def get_destination_filename(self, original_filename):
if original_filename.endswith(".crypt"):
return original_filename[:-6]
else:
return Decryptor.get_destination_filename(self, original_filename)
class PropertiesCryptoMixin(object):
""" Mixin to provide some common methods for Properties crypto """
default_xpath = '//*[@encrypted]'
def _get_elements(self, xdata):
""" Get the list of elements to encrypt or decrypt """
if Bcfg2.Options.setup.xpath:
elements = xdata.xpath(Bcfg2.Options.setup.xpath)
if not elements:
self.logger.warning("XPath expression %s matched no elements" %
Bcfg2.Options.setup.xpath)
else:
elements = xdata.xpath(self.default_xpath)
if not elements:
elements = list(xdata.getiterator(tag=lxml.etree.Element))
# filter out elements without text data
for el in elements[:]:
if not el.text:
elements.remove(el)
if Bcfg2.Options.setup.interactive:
for element in elements[:]:
if len(element):
elt = copy.copy(element)
for child in elt.iterchildren():
elt.remove(child)
else:
elt = element
print(lxml.etree.tostring(
elt,
xml_declaration=False).decode("UTF-8").strip())
ans = safe_input("Encrypt this element? [y/N] ")
if not ans.lower().startswith("y"):
elements.remove(element)
return elements
def _get_element_passphrase(self, element):
""" Get the passphrase to use to encrypt or decrypt a given
element """
pname = element.get("encrypted")
if pname in Bcfg2.Options.setup.passphrases:
passphrase = Bcfg2.Options.setup.passphrases[pname]
else:
if pname:
self.logger.warning("Passphrase %s not found in %s, "
"using passphrase given on command line" %
(pname, Bcfg2.Options.setup.config))
if self.passphrase:
passphrase = self.passphrase
pname = self.pname
else:
self.logger.warning("No passphrase specified for %s element" %
element.tag)
raise PassphraseError("Multiple passphrases found in %s, "
"specify one on the command line with "
"-p" % Bcfg2.Options.setup.config)
return (pname, passphrase)
def _write(self, filename, data):
""" Write the data """
data.getroottree().write(filename,
xml_declaration=False,
pretty_print=True)
class PropertiesEncryptor(Encryptor, PropertiesCryptoMixin):
""" encryptor class for Properties files """
def encrypt(self):
xdata = lxml.etree.XML(self.data, parser=XMLParser)
for elt in self._get_elements(xdata):
if is_encrypted(elt.text):
raise EncryptError("Element is already encrypted: %s" %
print_xml(elt))
try:
pname, passphrase = self._get_element_passphrase(elt)
except PassphraseError:
raise EncryptError(str(sys.exc_info()[1]))
self.logger.debug("Encrypting %s" % print_xml(elt))
elt.text = ssl_encrypt(elt.text, passphrase).strip()
elt.set("encrypted", pname)
return xdata
def _write(self, filename, data):
PropertiesCryptoMixin._write(self, filename, data)
class PropertiesDecryptor(Decryptor, PropertiesCryptoMixin):
""" decryptor class for Properties files """
def decrypt(self):
decrypted_any = False
xdata = lxml.etree.XML(self.data, parser=XMLParser)
for elt in self._get_elements(xdata):
try:
pname, passphrase = self._get_element_passphrase(elt)
except PassphraseError:
raise DecryptError(str(sys.exc_info()[1]))
self.logger.debug("Decrypting %s" % print_xml(elt))
try:
decrypted = ssl_decrypt(elt.text, passphrase).strip()
elt.text = decrypted.encode('ascii', 'xmlcharrefreplace')
elt.set("encrypted", pname)
decrypted_any = True
except (EVPError, TypeError):
self.logger.error("Could not decrypt %s, skipping" %
print_xml(elt))
except UnicodeDecodeError:
# we managed to decrypt the value, but it contains
# content that can't even be encoded into xml
# entities. what probably happened here is that we
# coincidentally could decrypt a value encrypted with
# a different key, and wound up with gibberish.
self.logger.warning("Decrypted %s to gibberish, skipping" %
elt.tag)
if decrypted_any:
return xdata
else:
raise DecryptError("Failed to decrypt any data in %s" %
self.filename)
def _write(self, filename, data):
PropertiesCryptoMixin._write(self, filename, data)
class CLI(object):
""" The bcfg2-crypt CLI """
options = [
Bcfg2.Options.ExclusiveOptionGroup(
Bcfg2.Options.BooleanOption(
"--encrypt", help='Encrypt the specified file'),
Bcfg2.Options.BooleanOption(
"--decrypt", help='Decrypt the specified file')),
Bcfg2.Options.BooleanOption(
"--stdout",
help='Decrypt or encrypt the specified file to stdout'),
Bcfg2.Options.Option(
"-p", "--passphrase", metavar="NAME",
help='Encryption passphrase name'),
Bcfg2.Options.ExclusiveOptionGroup(
Bcfg2.Options.BooleanOption(
"--properties",
help='Encrypt the specified file as a Properties file'),
Bcfg2.Options.BooleanOption(
"--cfg", help='Encrypt the specified file as a Cfg file')),
Bcfg2.Options.OptionGroup(
Bcfg2.Options.Common.interactive,
Bcfg2.Options.Option(
"--xpath",
help='XPath expression to select elements to encrypt'),
title="Options for handling Properties files"),
Bcfg2.Options.OptionGroup(
Bcfg2.Options.BooleanOption(
"--remove", help='Remove the plaintext file after encrypting'),
title="Options for handling Cfg files"),
Bcfg2.Options.PathOption(
"files", help="File(s) to encrypt or decrypt", nargs='+')]
def __init__(self, argv=None):
parser = Bcfg2.Options.get_parser(
description="Encrypt and decrypt Bcfg2 data",
components=[self, _OptionContainer])
parser.parse(argv=argv)
self.logger = logging.getLogger(parser.prog)
if Bcfg2.Options.setup.decrypt:
if Bcfg2.Options.setup.remove:
self.logger.error("--remove cannot be used with --decrypt, "
"ignoring --remove")
Bcfg2.Options.setup.remove = False
elif Bcfg2.Options.setup.interactive:
self.logger.error("Cannot decrypt interactively")
Bcfg2.Options.setup.interactive = False
def _is_properties(self, filename):
""" Determine if a given file is a Properties file or not """
if Bcfg2.Options.setup.properties:
return True
elif Bcfg2.Options.setup.cfg:
return False
elif filename.endswith(".xml"):
try:
xroot = lxml.etree.parse(filename).getroot()
return xroot.tag == "Properties"
except lxml.etree.XMLSyntaxError:
return False
else:
return False
def run(self): # pylint: disable=R0912,R0915
""" Run bcfg2-crypt """
for fname in Bcfg2.Options.setup.files:
if not os.path.exists(fname):
self.logger.error("%s does not exist, skipping" % fname)
continue
# figure out if we need to encrypt this as a Properties file
# or as a Cfg file
try:
props = self._is_properties(fname)
except IOError:
err = sys.exc_info()[1]
self.logger.error("Error reading %s, skipping: %s" %
(fname, err))
continue
if props:
ftype = "Properties"
if Bcfg2.Options.setup.remove:
self.logger.info("Cannot use --remove with Properties "
"file %s, ignoring for this file" % fname)
tools = (PropertiesEncryptor, PropertiesDecryptor)
else:
ftype = "Cfg"
if Bcfg2.Options.setup.xpath:
self.logger.error("Specifying --xpath with --cfg is "
"nonsensical, ignoring --xpath")
Bcfg2.Options.setup.xpath = None
if Bcfg2.Options.setup.interactive:
self.logger.error("Cannot use interactive mode with "
"--cfg, ignoring --interactive")
Bcfg2.Options.setup.interactive = False
tools = (CfgEncryptor, CfgDecryptor)
data = None
mode = None
if Bcfg2.Options.setup.encrypt:
try:
tool = tools[0](fname)
except PassphraseError:
self.logger.error(str(sys.exc_info()[1]))
continue
except IOError:
self.logger.error("Error reading %s, skipping: %s" %
(fname, err))
continue
mode = "encrypt"
self.logger.debug("Encrypting %s file %s" % (ftype, fname))
elif Bcfg2.Options.setup.decrypt:
try:
tool = tools[1](fname)
except PassphraseError:
self.logger.error(str(sys.exc_info()[1]))
continue
except IOError:
self.logger.error("Error reading %s, skipping: %s" %
(fname, err))
continue
mode = "decrypt"
self.logger.debug("Decrypting %s file %s" % (ftype, fname))
else:
self.logger.info("Neither --encrypt nor --decrypt specified, "
"determining mode")
try:
tool = tools[1](fname)
except PassphraseError:
self.logger.error(str(sys.exc_info()[1]))
continue
except IOError:
self.logger.error("Error reading %s, skipping: %s" %
(fname, err))
continue
try:
self.logger.debug("Trying to decrypt %s file %s" % (ftype,
fname))
data = tool.decrypt()
mode = "decrypt"
self.logger.debug("Decrypted %s file %s" % (ftype, fname))
except DecryptError:
self.logger.info("Failed to decrypt %s, trying encryption"
% fname)
try:
tool = tools[0](fname)
except PassphraseError:
self.logger.error(str(sys.exc_info()[1]))
continue
except IOError:
self.logger.error("Error reading %s, skipping: %s" %
(fname, err))
continue
mode = "encrypt"
self.logger.debug("Encrypting %s file %s" % (ftype, fname))
if data is None:
try:
data = getattr(tool, mode)()
except (EncryptError, DecryptError):
self.logger.error("Failed to %s %s, skipping: %s" %
(mode, fname, sys.exc_info()[1]))
continue
if Bcfg2.Options.setup.stdout:
if len(Bcfg2.Options.setup.files) > 1:
print("----- %s -----" % fname)
print(data)
if len(Bcfg2.Options.setup.files) > 1:
print("")
else:
tool.write(data)
if (Bcfg2.Options.setup.remove and
tool.get_destination_filename(fname) != fname):
try:
os.unlink(fname)
except IOError:
err = sys.exc_info()[1]
self.logger.error("Error removing %s: %s" % (fname, err))
continue
|