serializer.py 4.49 KB
Newer Older
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
#
#

# Copyright (C) 2007, 2008 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.

"""Serializer abstraction module

This module introduces a simple abstraction over the serialization
backend (currently json).

"""

import simplejson
import re
30
31
32
import hmac

from ganeti import errors
33

Guido Trotter's avatar
Guido Trotter committed
34
35
36
37
try:
  from hashlib import sha1
except ImportError:
  import sha as sha1
38

39
40
41
42
43
44
45
# Check whether the simplejson module supports indentation
_JSON_INDENT = 2
try:
  simplejson.dumps(1, indent=_JSON_INDENT)
except TypeError:
  _JSON_INDENT = None

46
_RE_EOLSP = re.compile('[ \t]+$', re.MULTILINE)
47
48


49
def DumpJson(data, indent=True):
50
51
  """Serialize a given object.

Iustin Pop's avatar
Iustin Pop committed
52
53
54
55
  @param data: the data to serialize
  @param indent: whether to indent output (depends on simplejson version)

  @return: the string representation of data
56

57
  """
58
  if not indent or _JSON_INDENT is None:
59
60
61
    txt = simplejson.dumps(data)
  else:
    txt = simplejson.dumps(data, indent=_JSON_INDENT)
62

63
  txt = _RE_EOLSP.sub("", txt)
64
65
66
67
68
  if not txt.endswith('\n'):
    txt += '\n'
  return txt


69
def LoadJson(txt):
70
71
  """Unserialize data from a string.

Iustin Pop's avatar
Iustin Pop committed
72
73
74
75
  @param txt: the json-encoded form

  @return: the original data

76
77
  """
  return simplejson.loads(txt)
78
79


80
81
82
83
84
85
86
87
88
89
90
91
92
93
def DumpSignedJson(data, key, salt=None):
  """Serialize a given object and authenticate it.

  @param data: the data to serialize
  @param key: shared hmac key
  @return: the string representation of data signed by the hmac key

  """
  txt = DumpJson(data, indent=False)
  if salt is None:
    salt = ''
  signed_dict = {
    'msg': txt,
    'salt': salt,
Guido Trotter's avatar
Guido Trotter committed
94
    'hmac': hmac.new(key, salt + txt, sha1).hexdigest(),
95
96
97
98
99
100
101
102
103
104
105
  }
  return DumpJson(signed_dict)


def LoadSignedJson(txt, key, salt_verifier=None):
  """Verify that a given message was signed with the given key, and load it.

  @param txt: json-encoded hmac-signed message
  @param key: shared hmac key
  @param salt_verifier: function taking a salt as input and returning boolean
  @rtype: tuple of original data, string
106
  @return: original data
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  @raises errors.SignatureError: if the message signature doesn't verify

  """
  signed_dict = LoadJson(txt)
  if not isinstance(signed_dict, dict):
    raise errors.SignatureError('Invalid external message')
  try:
    msg = signed_dict['msg']
    salt = signed_dict['salt']
    hmac_sign = signed_dict['hmac']
  except KeyError:
    raise errors.SignatureError('Invalid external message')

  if salt and not salt_verifier:
    raise errors.SignatureError('Salted message is not verified')
  elif salt_verifier is not None:
    if not salt_verifier(salt):
      raise errors.SignatureError('Invalid salt')

Guido Trotter's avatar
Guido Trotter committed
126
  if hmac.new(key, salt + msg, sha1).hexdigest() != hmac_sign:
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    raise errors.SignatureError('Invalid Signature')
  return LoadJson(msg)


def SaltEqualTo(expected):
  """Helper salt verifier function that checks for equality.

  @type expected: string
  @param expected: expected salt
  @rtype: function
  @return: salt verifier that returns True if the target salt is "x"

  """
  return lambda salt: salt == expected


def SaltIn(expected):
144
  """Helper salt verifier function that checks for membership.
145
146
147
148
149
150
151
152
153
154
155

  @type expected: collection
  @param expected: collection of possible valid salts
  @rtype: function
  @return: salt verifier that returns True if the salt is in the collection

  """
  return lambda salt: salt in expected


def SaltInRange(min, max):
156
  """Helper salt verifier function that checks for integer range.
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

  @type min: integer
  @param min: minimum salt value
  @type max: integer
  @param max: maximum salt value
  @rtype: function
  @return: salt verifier that returns True if the salt is in the min,max range

  """
  def _CheckSaltInRange(salt):
    try:
      i_salt = int(salt)
    except (TypeError, ValueError), err:
      return False

    return i_salt > min and i_salt < max

  return _CheckSaltInRange


177
178
Dump = DumpJson
Load = LoadJson
179
180
DumpSigned = DumpSignedJson
LoadSigned = LoadSignedJson