/usr/lib/python2.7/dist-packages/pskc/key.py is in python-pskc 0.2-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 | # key.py - module for handling keys from pskc files
# coding: utf-8
#
# Copyright (C) 2014 Arthur de Jong
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA
"""Module that handles keys stored in PSKC files."""
import base64
from pskc.encryption import EncryptedValue
from pskc.mac import ValueMAC
from pskc.policy import Policy
class DataType(object):
"""Provide access to possibly encrypted, MAC'ed information.
This class is meant to be subclassed to provide typed access to stored
values. Instances of this class provide the following attributes:
plain_value: raw unencrypted value if present (possibly base64 encoded)
encrypted_value: reference to an EncryptedValue instance
value_mac: reference to a ValueMAC instance
"""
def __init__(self, key, element=None):
self.plain_value = None
self.encrypted_value = EncryptedValue(key.pskc.encryption)
self.value_mac = ValueMAC(key.pskc.mac)
self.parse(element)
def parse(self, element):
"""Read information from the provided element.
The element is expected to contain <PlainValue>, <EncryptedValue>
and/or ValueMAC elements that contain information on the actual
value."""
from pskc.parse import find, findtext
if element is None:
return
self.plain_value = findtext(element, 'pskc:PlainValue')
self.encrypted_value.parse(find(element, 'pskc:EncryptedValue'))
self.value_mac.parse(find(element, 'pskc:ValueMAC'))
def set_value(self, value):
"""Save the plain value."""
self.plain_value = self.to_plain(value)
self.encrypted_value.cipher_value = None
def check(self):
"""Check whether the embedded MAC is correct."""
# this checks the encrypted value
return self.value_mac.check(self.encrypted_value.cipher_value)
class BinaryDataType(DataType):
"""Subclass of DataType for binary data (e.g. keys)."""
def get_value(self):
"""Provide the raw binary value."""
# plain value is base64 encoded
if self.plain_value is not None:
return base64.b64decode(self.plain_value)
# check MAC if present
self.check()
# encrypted value is in correct format
return self.encrypted_value.decrypt()
def to_plain(self, value):
"""Convert the value to an unencrypted string representation."""
if value:
return base64.b64encode(value)
class IntegerDataType(DataType):
"""Subclass of DataType for integer types (e.g. counters)."""
def get_value(self):
"""Provide the raw integer value."""
# plain value is a string representation of the number
if self.plain_value:
return int(self.plain_value)
# check MAC if present
self.check()
# decrypted value is big endian encoded
value = self.encrypted_value.decrypt()
if value is not None:
# Python3 has int.from_bytes(value, byteorder='big')
v = 0
for x in value:
v = (v << 8) + ord(x)
return v
def to_plain(self, value):
"""Convert the value to an unencrypted string representation."""
if value not in (None, ''):
return str(value)
class Key(object):
"""Representation of a single key from a PSKC file.
Instances of this class provide the following properties:
id: unique key identifier (should be constant between interchanges)
algorithm: identifier of the PSKC algorithm profile (URI)
secret: the secret key itself (binary form, automatically decrypted)
counter: event counter for event-based OTP
time_offset: time offset for time-based OTP algorithms (in intervals)
time_interval: time interval for time-based OTP in seconds
time_drift: device clock drift (negative means device is slow)
issuer: party that issued the key
key_profile: reference to pre-shared key profile information
key_reference: reference to an external key
friendly_name: human-readable name for the secret key
key_userid: user distinguished name associated with the key
manufacturer: name of the organisation that made the device
serial: serial number of the device
model: device model description
issue_no: issue number per serial number
device_binding: device (class) identifier for the key to be loaded upon
start_date: key should not be used before this date
expiry_date: key or device may expire after this date
device_userid: user distinguished name associated with the device
crypto_module: id of module to which keys are provisioned within device
algorithm_suite: additional algorithm characteristics (e.g. used hash)
challenge_encoding: format of the challenge for CR devices
challenge_min_length: minimum accepted challenge length by device
challenge_max_length: maximum size challenge accepted by the device
challenge_check: whether the device will check an embedded check digit
response_encoding: format of the response the device will generate
response_length: the length of the response of the device
response_check: whether the device appends a Luhn check digit
policy: reference to policy information (see Policy class)
"""
def __init__(self, pskc, key_package=None):
self.pskc = pskc
self.id = None
self.algorithm = None
self._secret = BinaryDataType(self)
self._counter = IntegerDataType(self)
self._time_offset = IntegerDataType(self)
self._time_interval = IntegerDataType(self)
self._time_drift = IntegerDataType(self)
self.issuer = None
self.key_profile = None
self.key_reference = None
self.friendly_name = None
self.key_userid = None
self.manufacturer = None
self.serial = None
self.model = None
self.issue_no = None
self.device_binding = None
self.start_date = None
self.expiry_date = None
self.device_userid = None
self.crypto_module = None
self.algorithm_suite = None
self.challenge_encoding = None
self.challenge_min_length = None
self.challenge_max_length = None
self.challenge_check = None
self.response_encoding = None
self.response_length = None
self.response_check = None
self.policy = Policy(self)
self.parse(key_package)
def parse(self, key_package):
"""Read key information from the provided <KeyPackage> tree."""
from pskc.parse import find, findtext, findtime, getint, getbool
if key_package is None:
return
key = find(key_package, 'pskc:Key')
if key is not None:
self.id = key.get('Id')
self.algorithm = key.get('Algorithm')
data = find(key_package, 'pskc:Key/pskc:Data')
if data is not None:
self._secret.parse(find(data, 'pskc:Secret'))
self._counter.parse(find(data, 'pskc:Counter'))
self._time_offset.parse(find(data, 'pskc:Time'))
self._time_interval.parse(find(data, 'pskc:TimeInterval'))
self._time_drift.parse(find(data, 'pskc:TimeDrift'))
self.issuer = findtext(key_package, 'pskc:Key/pskc:Issuer')
self.key_profile = findtext(key_package, 'pskc:Key/pskc:KeyProfileId')
self.key_reference = findtext(
key_package, 'pskc:Key/pskc:KeyReference')
self.friendly_name = findtext(
key_package, 'pskc:Key/pskc:FriendlyName')
# TODO: support multi-language values of <FriendlyName>
self.key_userid = findtext(key_package, 'pskc:Key/pskc:UserId')
self.manufacturer = findtext(
key_package, 'pskc:DeviceInfo/pskc:Manufacturer')
self.serial = findtext(key_package, 'pskc:DeviceInfo/pskc:SerialNo')
self.model = findtext(key_package, 'pskc:DeviceInfo/pskc:Model')
self.issue_no = findtext(key_package, 'pskc:DeviceInfo/pskc:IssueNo')
self.device_binding = findtext(
key_package, 'pskc:DeviceInfo/pskc:DeviceBinding')
self.start_date = findtime(
key_package, 'pskc:DeviceInfo/pskc:StartDate')
self.expiry_date = findtime(
key_package, 'pskc:DeviceInfo/pskc:ExpiryDate')
self.device_userid = findtext(
key_package, 'pskc:DeviceInfo/pskc:UserId')
self.crypto_module = findtext(
key_package, 'pskc:CryptoModuleInfo/pskc:Id')
self.algorithm_suite = findtext(
key_package, 'pskc:Key/pskc:AlgorithmParameters/pskc:Suite')
challenge_format = find(
key_package,
'pskc:Key/pskc:AlgorithmParameters/pskc:ChallengeFormat')
if challenge_format is not None:
self.challenge_encoding = challenge_format.get('Encoding')
self.challenge_min_length = getint(challenge_format, 'Min')
self.challenge_max_length = getint(challenge_format, 'Max')
self.challenge_check = getbool(challenge_format, 'CheckDigits')
response_format = find(
key_package,
'pskc:Key/pskc:AlgorithmParameters/pskc:ResponseFormat')
if response_format is not None:
self.response_encoding = response_format.get('Encoding')
self.response_length = getint(response_format, 'Length')
self.response_check = getbool(response_format, 'CheckDigits')
self.policy.parse(find(key_package, 'pskc:Key/pskc:Policy'))
secret = property(
fget=lambda self: self._secret.get_value(),
fset=lambda self, x: self._secret.set_value(x),
doc="The secret key itself.")
counter = property(
fget=lambda self: self._counter.get_value(),
fset=lambda self, x: self._counter.set_value(x),
doc="An event counter for event-based OTP.")
time_offset = property(
fget=lambda self: self._time_offset.get_value(),
fset=lambda self, x: self._time_offset.set_value(x),
doc="A time offset for time-based OTP (number of intervals).")
time_interval = property(
fget=lambda self: self._time_interval.get_value(),
fset=lambda self, x: self._time_interval.set_value(x),
doc="A time interval in seconds.")
time_drift = property(
fget=lambda self: self._time_drift.get_value(),
fset=lambda self, x: self._time_drift.set_value(x),
doc="Device clock drift value (number of time intervals).")
def check(self):
"""Check if all MACs in the message are valid."""
if any((self._secret.check(), self._counter.check(),
self._time_offset.check(), self._time_interval.check(),
self._time_drift.check())):
return True
|