summaryrefslogtreecommitdiff
path: root/wsgitools/digest.py
blob: 244eb9878483f6f8f06051edce3a402c54a0b008 (plain)
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
#!/usr/bin/env python2.5

__all__ = []

import random
import md5
import time

sysrand = random.SystemRandom()

def parse_digest_response(data, ret=dict()):
    """internal"""
    data = data.strip()
    key, rest = data.split('=', 1) # raises ValueError
    if rest.startswith('"'):
        rest = rest[1:]
        value, rest = rest.split('"', 1) # raises ValueError
        if not rest:
            ret[key] = value
            return ret
        if rest[0] != ',':
            raise ValueError, "invalid digest response"
        rest = rest[1:]
    else:
        if ',' not in rest:
            ret[key] = rest
            return ret
        value, rest = rest.split(',' , 1)
    ret[key] = value
    return parse_digest_response(rest, ret)

class AuthenticationRequired(Exception):
    pass

__all__.append("AuthTokenGenerator")
class AuthTokenGenerator:
    """Generates authentification tokens for AuthDigestMiddleware. The
    interface consists of beeing callable with a username and having a
    realm attribute being a string."""
    def __init__(self, realm, getpass):
        """Realm is a string according to RFC2617.
        The provided getpass function is called with a username and
        password is expected as result. None may be used as an invalid
        password."""
        self.realm = realm
        self.getpass = getpass
    def __call__(self, username, algo="md5"):
        """Generates an authentification token from a username."""
        assert algo.lower() in ["md5", "md5-sess"]
        password = self.getpass(username)
        if password is None:
            return None
        a1 = "%s:%s:%s" % (username, self.realm, password)
        return md5.new(a1).hexdigest()

__all__.append("AuthDigestMiddleware")
class AuthDigestMiddleware:
    """Middleware partly implementing RFC2617. (md5-sess was omited)"""
    algorithms = {"md5": lambda data: md5.new(data).hexdigest()}
    def __init__(self, app, gentoken, maxage=300, maxuses=5):
        """app is the wsgi application to be served with authentification.
        gentoken has to have the same functionality and interface as the
                 AuthTokenGenerator class.
        maxage is the number of seconds a nonce may be valid. Choosing a large
               value may result in more memory usage whereas a smaller value
               results in more requests. Defaults to 5 minutes.
        maxuses is the number of times a nonce may be used (with different nc
                values). A value of 1 makes nonces usable exactly once
                resulting in more requests. Defaults to 5.
        """
        self.app = app
        self.gentoken = gentoken
        self.maxage = maxage
        self.maxuses = maxuses
        self.server_secret = ("%066X" % sysrand.getrandbits(33*8)
                              ).decode("hex").encode("base64").strip()
        self.nonces = [] # [(creation_time, nonce_value, useage_count)]
                         # as [(float, str, int)]

    def __call__(self, environ, start_response):
        """wsgi interface"""
        self.cleanup_nonces()

        try:
            auth = environ["HTTP_AUTHORIZATION"] # raises KeyError
            method, rest = auth.split(' ', 1) # raises ValueError

            if method.lower() != "digest":
                raise AuthenticationRequired
            credentials = parse_digest_response(rest) # raises ValueError

            ### Check algorithm field
            credentials["algorithm"] = credentials.get("algorithm",
                                                       "md5").lower()
            if not credentials["algorithm"] in self.algorithms:
                raise AuthenticationRequired

            ### Check uri field
            # Doing this by stripping known parts from the passed uri field
            # until something trivial remains, as the uri cannot be
            # reconstructed from the environment exactly.
            uri = credentials["uri"] # raises KeyError
            if "QUERY_STRING" in environ and environ["QUERY_STRING"]:
                if not uri.endswith(environ["QUERY_STRING"]):
                    raise AuthenticationRequired
                uri = uri[:-len(environ["QUERY_STRING"])]
            if "SCRIPT_NAME" in environ:
                if not uri.startswith(environ["SCRIPT_NAME"]):
                    raise AuthenticationRequired
                uri = uri[len(environ["SCRIPT_NAME"]):]
            if "PATH_INFO" in environ:
                if not uri.startswith(environ["PATH_INFO"]):
                    raise AuthenticationRequired
                uri = uri[len(environ["PATH_INFO"]):]
            if uri not in ('', '?'):
                raise AuthenticationRequired
            del uri

            if ("username" not in credentials or
                    "nonce" not in credentials or
                    "response" not in credentials or
                    "qop" in credentials and (
                        credentials["qop"] != "auth" or 
                        "nc" not in credentials or
                        credentials["nc"].lower().strip("0123456789abcdef") or
                        "cnonce" not in credentials)):
                raise AuthenticationRequired

            if not self.is_nonce(credentials): # riases KeyError, ValueError
                raise AuthenticationRequired

            if not self.check_nonce(credentials): # raises KeyError, ValueError
                return self.authorization_required(environ, start_response,
                                                   stale=True) # stale nonce!

            # raises KeyError, ValueError
            response = self.auth_response(credentials,
                                          environ["REQUEST_METHOD"])
            if response is None or response != credentials["response"]:
                raise AuthenticationRequired

        except (KeyError, ValueError, AuthenticationRequired):
            return self.authorization_required(environ, start_response)
        else:
            environ["REMOTE_USER"] = credentials["username"]
            def modified_start_response(status, headers, exc_info=None):
                digest = dict(nextnonce=self.new_nonce())
                if "qop" in credentials:
                    digest["qop"] = "auth"
                    digest["cnonce"] = credentials["cnonce"] # no KeyError
                    digest["rspauth"] = self.auth_response(credentials, "")
                challenge = ", ".join(map('%s="%s"'.__mod__, digest.items()))
                headers.append(("Authentication-Info", challenge))
                return start_response(status, headers, exc_info)
            return self.app(environ, modified_start_response)

    def auth_response(self, credentials, reqmethod):
        """internal method generating authentication tokens"""
        username = credentials["username"]
        algo = credentials["algorithm"]
        uri = credentials["uri"]
        nonce = credentials["nonce"]
        a1h = self.gentoken(username, algo)
        if a1h is None:
            raise ValueError
        a2 = "%s:%s" % (reqmethod, uri)
        a2h = self.algorithms[algo](a2)
        qop = credentials.get("qop", None)
        if qop is None:
            dig = ":".join((a1h, nonce, a2h))
        else:
            nc = credentials["nc"] # raises KeyError
            cnonce = credentials["cnonce"] # raises KeyError
            if qop != "auth":
                return ValueError
            dig =  ":".join((a1h, nonce, nc, cnonce, qop, a2h))
        digh = self.algorithms[algo](dig)
        return digh

    def cleanup_nonces(self):
        """internal methods cleaning list of valid nonces"""
        # see new_nonce
        old = "%13X" % long((time.time() - self.maxage) * 1000000)
        while self.nonces and self.nonces[0][0] < old:
            self.nonces.pop(0)

    def is_nonce(self, credentials):
        """internal method checking whether a nonce might be from this server"""
        nonce = credentials["nonce"] # raises KeyError
        # raises ValueError
        nonce_time, nonce_value, nonce_hash = nonce.split(':')
        token = "%s:%s:%s" % (nonce_time, nonce_value, self.server_secret)
        token = md5.new(token).hexdigest()
        return nonce_hash == token

    def check_nonce(self, credentials):
        """internal method checking nonce validity"""
        nonce = credentials["nonce"]
        # raises ValueError
        nonce_time, nonce_value, nonce_hash = nonce.split(':')
        qop = credentials.get("qop", None)
        if qop is None:
            nc = 1
        else:
            nc = long(credentials["nc"], 16) # raises KeyError, ValueError
        # searching nonce_time
        lower, upper = 0, len(self.nonces) - 1
        while lower < upper:
            mid = (lower + upper) // 2
            if nonce_time <= self.nonces[mid][0]:
                upper = mid
            else:
                lower = mid + 1

        (nt, nv, uses) = self.nonces[lower]
        if nt != nonce_time or nv != nonce_value:
            return False
        if nc != uses:
            del self.nonces[lower]
            return False
        if uses >= self.maxuses:
            del self.nonces[lower]
        else:
            self.nonces[lower] = (nt, nv, uses+1)
        return True

    def new_nonce(self):
        """internal method generating a new nonce"""
        # 13 = (32 bit + 20 bit) / 4
        nonce_time = "%13X" % long(time.time() * 1000000)
        randval = sysrand.getrandbits(33*8)
        nonce_value = ("%066X" % randval).decode("hex").encode("base64").strip()
        self.nonces.append((nonce_time, nonce_value, 1))
        token = "%s:%s:%s" % (nonce_time, nonce_value, self.server_secret)
        token = md5.new(token).hexdigest()
        return "%s:%s:%s" % (nonce_time, nonce_value, token)

    def authorization_required(self, environ, start_response, stale=False):
        """internal method implementing wsgi interface, serving 401 page"""
        nonce = self.new_nonce()
        digest = dict(nonce=nonce,
                      realm=self.gentoken.realm,
                      algorithm="md5",
                      qop="auth")
        if stale:
            digest["stale"] = "TRUE"
        challenge = ", ".join(map('%s="%s"'.__mod__, digest.items()))
        status = "401 Not authorized"
        headers = [("Content-type", "text/html"),
                   ("WWW-Authenticate", "Digest %s" % challenge)]
        data = "<html><head><title>401 Not authorized</title></head><body><h1>"
        data += "401 Not authorized</h1></body></html>"
        headers.append(("Content-length", str(len(data))))
        start_response(status, headers)
        if environ["REQUEST_METHOD"] == "HEAD":
            return []
        return [data]