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
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
|
/*
This file is part of libmicrohttpd
Copyright (C) 2010, 2011, 2012, 2015, 2018 Daniel Pittman and Christian Grothoff
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
*/
/**
* @file digestauth.c
* @brief Implements HTTP digest authentication
* @author Amr Ali
* @author Matthieu Speder
* @author Christian Grothoff (RFC 7616 support)
*/
#include "platform.h"
#include "mhd_limits.h"
#include "internal.h"
#include "md5.h"
#include "sha256.h"
#include "mhd_mono_clock.h"
#include "mhd_str.h"
#include "mhd_compat.h"
#include "mhd_assert.h"
#if defined(MHD_W32_MUTEX_)
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN 1
#endif /* !WIN32_LEAN_AND_MEAN */
#include <windows.h>
#endif /* MHD_W32_MUTEX_ */
/**
* 32 bit value is 4 bytes
*/
#define TIMESTAMP_BIN_SIZE 4
/**
* Standard server nonce length, not including terminating null,
*
* @param digest_size digest size
*/
#define NONCE_STD_LEN(digest_size) \
((digest_size) * 2 + TIMESTAMP_BIN_SIZE * 2)
/**
* Maximum size of any digest hash supported by MHD.
* (SHA-256 > MD5).
*/
#define MAX_DIGEST SHA256_DIGEST_SIZE
/**
* Macro to avoid using VLAs if the compiler does not support them.
*/
#ifndef HAVE_C_VARARRAYS
/**
* Return #MAX_DIGEST.
*
* @param n length of the digest to be used for a VLA
*/
#define VLA_ARRAY_LEN_DIGEST(n) (MAX_DIGEST)
#else
/**
* Return @a n.
*
* @param n length of the digest to be used for a VLA
*/
#define VLA_ARRAY_LEN_DIGEST(n) (n)
#endif
/**
* Check that @a n is below #MAX_DIGEST
*/
#define VLA_CHECK_LEN_DIGEST(n) do { if ((n) > MAX_DIGEST) mhd_panic ( \
mhd_panic_cls, __FILE__, __LINE__, \
"VLA too big.\n"); } while (0)
/**
* Beginning string for any valid Digest authentication header.
*/
#define _BASE "Digest "
/**
* Maximum length of a username for digest authentication.
*/
#define MAX_USERNAME_LENGTH 128
/**
* Maximum length of a realm for digest authentication.
*/
#define MAX_REALM_LENGTH 256
/**
* Maximum length of the response in digest authentication.
*/
#define MAX_AUTH_RESPONSE_LENGTH 256
/**
* Context passed to functions that need to calculate
* a digest but are orthogonal to the specific
* algorithm.
*/
struct DigestAlgorithm
{
/**
* Size of the final digest returned by @e digest.
*/
unsigned int digest_size;
/**
* A context for the digest algorithm, already initialized to be
* useful for @e init, @e update and @e digest.
*/
void *ctx;
/**
* Name of the algorithm, "md5" or "sha-256"
*/
const char *alg;
/**
* Buffer of @e digest_size * 2 + 1 bytes.
*/
char *sessionkey;
/**
* Call to initialize @e ctx.
*/
void
(*init)(void *ctx);
/**
* Feed more data into the digest function.
*
* @param ctx context to feed
* @param length number of bytes in @a data
* @param data data to add
*/
void
(*update)(void *ctx,
const uint8_t *data,
size_t length);
/**
* Compute final @a digest.
*
* @param ctx context to use
* @param[out] digest where to write the result,
* must be @e digest_length bytes long
*/
void
(*digest)(void *ctx,
uint8_t *digest);
};
/**
* convert bin to hex
*
* @param bin binary data
* @param len number of bytes in bin
* @param hex pointer to len*2+1 bytes
*/
static void
cvthex (const unsigned char *bin,
size_t len,
char *hex)
{
size_t i;
unsigned int j;
for (i = 0; i < len; ++i)
{
j = (bin[i] >> 4) & 0x0f;
hex[i * 2] = (char) ((j <= 9) ? (j + '0') : (j - 10 + 'a'));
j = bin[i] & 0x0f;
hex[i * 2 + 1] = (char) ((j <= 9) ? (j + '0') : (j - 10 + 'a'));
}
hex[len * 2] = '\0';
}
/**
* calculate H(A1) from given hash as per RFC2617 spec
* and store the * result in 'sessionkey'.
*
* @param alg The hash algorithm used, can be "md5" or "md5-sess"
* or "sha-256" or "sha-256-sess"
* Note that the rest of the code does not support the the "-sess" variants!
* @param[in,out] da digest implementation, must match @a alg; the
* da->sessionkey will be initialized to the digest in HEX
* @param digest An `unsigned char *' pointer to the binary MD5 sum
* for the precalculated hash value "username:realm:password"
* of #MHD_MD5_DIGEST_SIZE or #SHA256_DIGEST_SIZE bytes
* @param nonce A `char *' pointer to the nonce value
* @param cnonce A `char *' pointer to the cnonce value
*/
static void
digest_calc_ha1_from_digest (const char *alg,
struct DigestAlgorithm *da,
const uint8_t *digest,
const char *nonce,
const char *cnonce)
{
const unsigned int digest_size = da->digest_size;
if ( (MHD_str_equal_caseless_ (alg,
"md5-sess")) ||
(MHD_str_equal_caseless_ (alg,
"sha-256-sess")) )
{
uint8_t dig[VLA_ARRAY_LEN_DIGEST (digest_size)];
VLA_CHECK_LEN_DIGEST (digest_size);
da->init (da->ctx);
da->update (da->ctx,
digest,
MHD_MD5_DIGEST_SIZE);
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) nonce,
strlen (nonce));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) cnonce,
strlen (cnonce));
da->digest (da->ctx,
dig);
cvthex (dig,
digest_size,
da->sessionkey);
}
else
{
cvthex (digest,
digest_size,
da->sessionkey);
}
}
/**
* calculate H(A1) from username, realm and password as per RFC2617 spec
* and store the result in 'sessionkey'.
*
* @param alg The hash algorithm used, can be "md5" or "md5-sess"
* or "sha-256" or "sha-256-sess"
* @param username A `char *' pointer to the username value
* @param realm A `char *' pointer to the realm value
* @param password A `char *' pointer to the password value
* @param nonce A `char *' pointer to the nonce value
* @param cnonce A `char *' pointer to the cnonce value
* @param[in,out] da digest algorithm to use, and where to write
* the sessionkey to
*/
static void
digest_calc_ha1_from_user (const char *alg,
const char *username,
const char *realm,
const char *password,
const char *nonce,
const char *cnonce,
struct DigestAlgorithm *da)
{
unsigned char ha1[VLA_ARRAY_LEN_DIGEST (da->digest_size)];
VLA_CHECK_LEN_DIGEST (da->digest_size);
da->init (da->ctx);
da->update (da->ctx,
(const unsigned char *) username,
strlen (username));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) realm,
strlen (realm));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) password,
strlen (password));
da->digest (da->ctx,
ha1);
digest_calc_ha1_from_digest (alg,
da,
ha1,
nonce,
cnonce);
}
/**
* Calculate request-digest/response-digest as per RFC2617 / RFC7616
* spec.
*
* @param ha1 H(A1), twice the @a da->digest_size + 1 bytes (0-terminated),
* MUST NOT be aliased with `da->sessionkey`!
* @param nonce nonce from server
* @param noncecount 8 hex digits
* @param cnonce client nonce
* @param qop qop-value: "", "auth" or "auth-int" (NOTE: only 'auth' is supported today.)
* @param method method from request
* @param uri requested URL
* @param hentity H(entity body) if qop="auth-int"
* @param[in,out] da digest algorithm to use, also
* we write da->sessionkey (set to response request-digest or response-digest)
*/
static void
digest_calc_response (const char *ha1,
const char *nonce,
const char *noncecount,
const char *cnonce,
const char *qop,
const char *method,
const char *uri,
const char *hentity,
struct DigestAlgorithm *da)
{
const unsigned int digest_size = da->digest_size;
unsigned char ha2[VLA_ARRAY_LEN_DIGEST (digest_size)];
unsigned char resphash[VLA_ARRAY_LEN_DIGEST (digest_size)];
(void) hentity; /* Unused. Silence compiler warning. */
VLA_CHECK_LEN_DIGEST (digest_size);
da->init (da->ctx);
da->update (da->ctx,
(const unsigned char *) method,
strlen (method));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) uri,
strlen (uri));
#if 0
if (0 == strcasecmp (qop,
"auth-int"))
{
/* This is dead code since the rest of this module does
not support auth-int. */
da->update (da->ctx,
":",
1);
if (NULL != hentity)
da->update (da->ctx,
hentity,
strlen (hentity));
}
#endif
da->digest (da->ctx,
ha2);
cvthex (ha2,
digest_size,
da->sessionkey);
da->init (da->ctx);
/* calculate response */
da->update (da->ctx,
(const unsigned char *) ha1,
digest_size * 2);
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) nonce,
strlen (nonce));
da->update (da->ctx,
(const unsigned char *) ":",
1);
if ('\0' != *qop)
{
da->update (da->ctx,
(const unsigned char *) noncecount,
strlen (noncecount));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) cnonce,
strlen (cnonce));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) qop,
strlen (qop));
da->update (da->ctx,
(const unsigned char *) ":",
1);
}
da->update (da->ctx,
(const unsigned char *) da->sessionkey,
digest_size * 2);
da->digest (da->ctx,
resphash);
cvthex (resphash,
digest_size,
da->sessionkey);
}
/**
* Lookup subvalue off of the HTTP Authorization header.
*
* A description of the input format for 'data' is at
* http://en.wikipedia.org/wiki/Digest_access_authentication
*
*
* @param dest where to store the result (possibly truncated if
* the buffer is not big enough).
* @param size size of dest
* @param data pointer to the Authorization header
* @param key key to look up in data
* @return size of the located value, 0 if otherwise
*/
static size_t
lookup_sub_value (char *dest,
size_t size,
const char *data,
const char *key)
{
size_t keylen;
size_t len;
const char *ptr;
const char *eq;
const char *q1;
const char *q2;
const char *qn;
if (0 == size)
return 0;
keylen = strlen (key);
ptr = data;
while ('\0' != *ptr)
{
if (NULL == (eq = strchr (ptr,
'=')))
return 0;
q1 = eq + 1;
while (' ' == *q1)
q1++;
if ('\"' != *q1)
{
q2 = strchr (q1,
',');
qn = q2;
}
else
{
q1++;
q2 = strchr (q1,
'\"');
if (NULL == q2)
return 0; /* end quote not found */
qn = q2 + 1;
}
if ( (MHD_str_equal_caseless_n_ (ptr,
key,
keylen)) &&
(eq == &ptr[keylen]) )
{
if (NULL == q2)
{
len = strlen (q1) + 1;
if (size > len)
size = len;
size--;
memcpy (dest,
q1,
size);
dest[size] = '\0';
return size;
}
else
{
if (size > (size_t) ((q2 - q1) + 1))
size = (q2 - q1) + 1;
size--;
memcpy (dest,
q1,
size);
dest[size] = '\0';
return size;
}
}
if (NULL == qn)
return 0;
ptr = strchr (qn,
',');
if (NULL == ptr)
return 0;
ptr++;
while (' ' == *ptr)
ptr++;
}
return 0;
}
/**
* Check nonce-nc map array with either new nonce counter
* or a whole new nonce.
*
* @param connection The MHD connection structure
* @param nonce A pointer that referenced a zero-terminated array of nonce
* @param nc The nonce counter, zero to add the nonce to the array
* @return #MHD_YES if successful, #MHD_NO if invalid (or we have no NC array)
*/
static enum MHD_Result
check_nonce_nc (struct MHD_Connection *connection,
const char *nonce,
uint64_t nc)
{
struct MHD_Daemon *daemon = connection->daemon;
struct MHD_NonceNc *nn;
uint32_t off;
uint32_t mod;
const char *np;
size_t noncelen;
noncelen = strlen (nonce) + 1;
if (MAX_NONCE_LENGTH < noncelen)
return MHD_NO; /* This should be impossible, but static analysis
tools have a hard time with it *and* this also
protects against unsafe modifications that may
happen in the future... */
mod = daemon->nonce_nc_size;
if (0 == mod)
return MHD_NO; /* no array! */
/* super-fast xor-based "hash" function for HT lookup in nonce array */
off = 0;
np = nonce;
while ('\0' != *np)
{
off = (off << 8) | (*np ^ (off >> 24));
np++;
}
off = off % mod;
/*
* Look for the nonce, if it does exist and its corresponding
* nonce counter is less than the current nonce counter by 1,
* then only increase the nonce counter by one.
*/
nn = &daemon->nnc[off];
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
MHD_mutex_lock_chk_ (&daemon->nnc_lock);
#endif
if (0 == nc)
{
/* Fresh nonce, reinitialize array */
memcpy (nn->nonce,
nonce,
noncelen);
nn->nc = 0;
nn->nmask = 0;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
MHD_mutex_unlock_chk_ (&daemon->nnc_lock);
#endif
return MHD_YES;
}
/* Note that we use 64 here, as we do not store the
bit for 'nn->nc' itself in 'nn->nmask' */
if ( (nc < nn->nc) &&
(nc + 64 > nc /* checking for overflow */) &&
(nc + 64 >= nn->nc) &&
(0 == ((1LLU << (nn->nc - nc - 1)) & nn->nmask)) )
{
/* Out-of-order nonce, but within 64-bit bitmask, set bit */
nn->nmask |= (1LLU << (nn->nc - nc - 1));
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
MHD_mutex_unlock_chk_ (&daemon->nnc_lock);
#endif
return MHD_YES;
}
if ( (nc <= nn->nc) ||
(0 != strcmp (nn->nonce,
nonce)) )
{
/* Nonce does not match, fail */
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
MHD_mutex_unlock_chk_ (&daemon->nnc_lock);
#endif
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ (
"Stale nonce received. If this happens a lot, you should probably increase the size of the nonce array.\n"));
#endif
return MHD_NO;
}
/* Nonce is larger, shift bitmask and bump limit */
if (64 > nc - nn->nc)
nn->nmask <<= (nc - nn->nc); /* small jump, less than mask width */
else
nn->nmask = 0; /* big jump, unset all bits in the mask */
nn->nc = nc;
#if defined(MHD_USE_POSIX_THREADS) || defined(MHD_USE_W32_THREADS)
MHD_mutex_unlock_chk_ (&daemon->nnc_lock);
#endif
return MHD_YES;
}
/**
* Get the username from the authorization header sent by the client
*
* @param connection The MHD connection structure
* @return NULL if no username could be found, a pointer
* to the username if found
* @warning Returned value must be freed by #MHD_free().
* @ingroup authentication
*/
char *
MHD_digest_auth_get_username (struct MHD_Connection *connection)
{
char user[MAX_USERNAME_LENGTH];
const char *header;
if (MHD_NO == MHD_lookup_connection_value_n (connection,
MHD_HEADER_KIND,
MHD_HTTP_HEADER_AUTHORIZATION,
MHD_STATICSTR_LEN_ (
MHD_HTTP_HEADER_AUTHORIZATION),
&header,
NULL))
return NULL;
if (0 != strncmp (header,
_BASE,
MHD_STATICSTR_LEN_ (_BASE)))
return NULL;
header += MHD_STATICSTR_LEN_ (_BASE);
if (0 == lookup_sub_value (user,
sizeof (user),
header,
"username"))
return NULL;
return strdup (user);
}
/**
* Calculate the server nonce so that it mitigates replay attacks
* The current format of the nonce is ...
* H(timestamp ":" method ":" random ":" uri ":" realm) + Hex(timestamp)
*
* @param nonce_time The amount of time in seconds for a nonce to be invalid
* @param method HTTP method
* @param rnd A pointer to a character array for the random seed
* @param rnd_size The size of the random seed array @a rnd
* @param uri HTTP URI (in MHD, without the arguments ("?k=v")
* @param realm A string of characters that describes the realm of auth.
* @param da digest algorithm to use
* @param[out] nonce A pointer to a character array for the nonce to put in,
* must provide NONCE_STD_LEN(da->digest_size)+1 bytes
*/
static void
calculate_nonce (uint32_t nonce_time,
const char *method,
const char *rnd,
size_t rnd_size,
const char *uri,
const char *realm,
struct DigestAlgorithm *da,
char *nonce)
{
unsigned char timestamp[TIMESTAMP_BIN_SIZE];
const unsigned int digest_size = da->digest_size;
unsigned char tmpnonce[VLA_ARRAY_LEN_DIGEST (digest_size)];
VLA_CHECK_LEN_DIGEST (digest_size);
da->init (da->ctx);
timestamp[0] = (unsigned char) ((nonce_time & 0xff000000) >> 0x18);
timestamp[1] = (unsigned char) ((nonce_time & 0x00ff0000) >> 0x10);
timestamp[2] = (unsigned char) ((nonce_time & 0x0000ff00) >> 0x08);
timestamp[3] = (unsigned char) ((nonce_time & 0x000000ff));
da->update (da->ctx,
timestamp,
sizeof (timestamp));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) method,
strlen (method));
da->update (da->ctx,
(const unsigned char *) ":",
1);
if (rnd_size > 0)
da->update (da->ctx,
(const unsigned char *) rnd,
rnd_size);
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) uri,
strlen (uri));
da->update (da->ctx,
(const unsigned char *) ":",
1);
da->update (da->ctx,
(const unsigned char *) realm,
strlen (realm));
da->digest (da->ctx,
tmpnonce);
cvthex (tmpnonce,
digest_size,
nonce);
cvthex (timestamp,
sizeof (timestamp),
nonce + digest_size * 2);
}
/**
* Test if the given key-value pair is in the headers for the
* given connection.
*
* @param connection the connection
* @param key the key
* @param key_size number of bytes in @a key
* @param value the value, can be NULL
* @param value_size number of bytes in @a value
* @param kind type of the header
* @return #MHD_YES if the key-value pair is in the headers,
* #MHD_NO if not
*/
static enum MHD_Result
test_header (struct MHD_Connection *connection,
const char *key,
size_t key_size,
const char *value,
size_t value_size,
enum MHD_ValueKind kind)
{
struct MHD_HTTP_Header *pos;
for (pos = connection->headers_received; NULL != pos; pos = pos->next)
{
if (kind != pos->kind)
continue;
if (key_size != pos->header_size)
continue;
if (value_size != pos->value_size)
continue;
if (0 != memcmp (key,
pos->header,
key_size))
continue;
if ( (NULL == value) &&
(NULL == pos->value) )
return MHD_YES;
if ( (NULL == value) ||
(NULL == pos->value) ||
(0 != memcmp (value,
pos->value,
value_size)) )
continue;
return MHD_YES;
}
return MHD_NO;
}
/**
* Check that the arguments given by the client as part
* of the authentication header match the arguments we
* got as part of the HTTP request URI.
*
* @param connection connections with headers to compare against
* @param args argument URI string (after "?" in URI)
* @return #MHD_YES if the arguments match,
* #MHD_NO if not
*/
static enum MHD_Result
check_argument_match (struct MHD_Connection *connection,
const char *args)
{
struct MHD_HTTP_Header *pos;
char *argb;
unsigned int num_headers;
enum MHD_Result ret;
argb = strdup (args);
if (NULL == argb)
{
#ifdef HAVE_MESSAGES
MHD_DLOG (connection->daemon,
_ ("Failed to allocate memory for copy of URI arguments.\n"));
#endif /* HAVE_MESSAGES */
return MHD_NO;
}
ret = MHD_parse_arguments_ (connection,
MHD_GET_ARGUMENT_KIND,
argb,
&test_header,
&num_headers);
free (argb);
if (MHD_NO == ret)
{
return MHD_NO;
}
/* also check that the number of headers matches */
for (pos = connection->headers_received; NULL != pos; pos = pos->next)
{
if (MHD_GET_ARGUMENT_KIND != pos->kind)
continue;
num_headers--;
}
if (0 != num_headers)
{
/* argument count mismatch */
return MHD_NO;
}
return MHD_YES;
}
/**
* Authenticates the authorization header sent by the client
*
* @param connection The MHD connection structure
* @param[in,out] da digest algorithm to use for checking (written to as
* part of the calculations, but the values left in the struct
* are not actually expected to be useful for the caller)
* @param realm The realm presented to the client
* @param username The username needs to be authenticated
* @param password The password used in the authentication
* @param digest An optional binary hash
* of the precalculated hash value "username:realm:password"
* (must contain "da->digest_size" bytes or be NULL)
* @param nonce_timeout The amount of time for a nonce to be
* invalid in seconds
* @return #MHD_YES if authenticated, #MHD_NO if not,
* #MHD_INVALID_NONCE if nonce is invalid
* @ingroup authentication
*/
static int
digest_auth_check_all (struct MHD_Connection *connection,
struct DigestAlgorithm *da,
const char *realm,
const char *username,
const char *password,
const uint8_t *digest,
unsigned int nonce_timeout)
{
struct MHD_Daemon *daemon = connection->daemon;
size_t len;
const char *header;
char nonce[MAX_NONCE_LENGTH];
char cnonce[MAX_NONCE_LENGTH];
const unsigned int digest_size = da->digest_size;
char ha1[VLA_ARRAY_LEN_DIGEST (digest_size) * 2 + 1];
char qop[15]; /* auth,auth-int */
char nc[20];
char response[MAX_AUTH_RESPONSE_LENGTH];
const char *hentity = NULL; /* "auth-int" is not supported */
char noncehashexp[NONCE_STD_LEN (VLA_ARRAY_LEN_DIGEST (digest_size)) + 1];
uint32_t nonce_time;
uint32_t t;
size_t left; /* number of characters left in 'header' for 'uri' */
uint64_t nci;
char *qmark;
VLA_CHECK_LEN_DIGEST (digest_size);
if (MHD_NO == MHD_lookup_connection_value_n (connection,
MHD_HEADER_KIND,
MHD_HTTP_HEADER_AUTHORIZATION,
MHD_STATICSTR_LEN_ (
MHD_HTTP_HEADER_AUTHORIZATION),
&header,
NULL))
return MHD_NO;
if (0 != strncmp (header,
_BASE,
MHD_STATICSTR_LEN_ (_BASE)))
return MHD_NO;
header += MHD_STATICSTR_LEN_ (_BASE);
left = strlen (header);
{
char un[MAX_USERNAME_LENGTH];
len = lookup_sub_value (un,
sizeof (un),
header,
"username");
if ( (0 == len) ||
(0 != strcmp (username,
un)) )
return MHD_NO;
left -= strlen ("username") + len;
}
{
char r[MAX_REALM_LENGTH];
len = lookup_sub_value (r,
sizeof (r),
header,
"realm");
if ( (0 == len) ||
(0 != strcmp (realm,
r)) )
return MHD_NO;
left -= strlen ("realm") + len;
}
if (0 == (len = lookup_sub_value (nonce,
sizeof (nonce),
header,
"nonce")))
return MHD_NO;
left -= strlen ("nonce") + len;
if (left > 32 * 1024)
{
/* we do not permit URIs longer than 32k, as we want to
make sure to not blow our stack (or per-connection
heap memory limit). Besides, 32k is already insanely
large, but of course in theory the
#MHD_OPTION_CONNECTION_MEMORY_LIMIT might be very large
and would thus permit sending a >32k authorization
header value. */
return MHD_NO;
}
if (TIMESTAMP_BIN_SIZE * 2 !=
MHD_strx_to_uint32_n_ (nonce + len - TIMESTAMP_BIN_SIZE * 2,
TIMESTAMP_BIN_SIZE * 2,
&nonce_time))
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Authentication failed, invalid timestamp format.\n"));
#endif
return MHD_NO;
}
t = (uint32_t) MHD_monotonic_sec_counter ();
/*
* First level vetting for the nonce validity: if the timestamp
* attached to the nonce exceeds `nonce_timeout', then the nonce is
* invalid.
*/
if ( (t > nonce_time + nonce_timeout) ||
(nonce_time + nonce_timeout < nonce_time) )
{
/* too old */
return MHD_INVALID_NONCE;
}
calculate_nonce (nonce_time,
connection->method,
daemon->digest_auth_random,
daemon->digest_auth_rand_size,
connection->url,
realm,
da,
noncehashexp);
/*
* Second level vetting for the nonce validity
* if the timestamp attached to the nonce is valid
* and possibly fabricated (in case of an attack)
* the attacker must also know the random seed to be
* able to generate a "sane" nonce, which if he does
* not, the nonce fabrication process going to be
* very hard to achieve.
*/
if (0 != strcmp (nonce,
noncehashexp))
{
return MHD_INVALID_NONCE;
}
if ( (0 == lookup_sub_value (cnonce,
sizeof (cnonce),
header,
"cnonce")) ||
(0 == lookup_sub_value (qop,
sizeof (qop),
header,
"qop")) ||
( (0 != strcmp (qop,
"auth")) &&
(0 != strcmp (qop,
"")) ) ||
(0 == (len = lookup_sub_value (nc,
sizeof (nc),
header,
"nc")) ) ||
(0 == lookup_sub_value (response,
sizeof (response),
header,
"response")) )
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Authentication failed, invalid format.\n"));
#endif
return MHD_NO;
}
if (len != MHD_strx_to_uint64_n_ (nc,
len,
&nci))
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Authentication failed, invalid nc format.\n"));
#endif
return MHD_NO; /* invalid nonce format */
}
/*
* Checking if that combination of nonce and nc is sound
* and not a replay attack attempt. Also adds the nonce
* to the nonce-nc map if it does not exist there.
*/
if (MHD_NO ==
check_nonce_nc (connection,
nonce,
nci))
{
return MHD_NO;
}
{
char *uri;
uri = malloc (left + 1);
if (NULL == uri)
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Failed to allocate memory for auth header processing.\n"));
#endif /* HAVE_MESSAGES */
return MHD_NO;
}
if (0 == lookup_sub_value (uri,
left + 1,
header,
"uri"))
{
free (uri);
return MHD_NO;
}
if (NULL != digest)
{
/* This will initialize da->sessionkey (ha1) */
digest_calc_ha1_from_digest (da->alg,
da,
digest,
nonce,
cnonce);
}
else
{
/* This will initialize da->sessionkey (ha1) */
mhd_assert (NULL != password); /* NULL == digest => password != NULL */
digest_calc_ha1_from_user (da->alg,
username,
realm,
password,
nonce,
cnonce,
da);
}
memcpy (ha1,
da->sessionkey,
digest_size * 2 + 1);
/* This will initialize da->sessionkey (respexp) */
digest_calc_response (ha1,
nonce,
nc,
cnonce,
qop,
connection->method,
uri,
hentity,
da);
qmark = strchr (uri,
'?');
if (NULL != qmark)
*qmark = '\0';
/* Need to unescape URI before comparing with connection->url */
daemon->unescape_callback (daemon->unescape_callback_cls,
connection,
uri);
if (0 != strcmp (uri,
connection->url))
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Authentication failed, URI does not match.\n"));
#endif
free (uri);
return MHD_NO;
}
{
const char *args = qmark;
if (NULL == args)
args = "";
else
args++;
if (MHD_NO ==
check_argument_match (connection,
args) )
{
#ifdef HAVE_MESSAGES
MHD_DLOG (daemon,
_ ("Authentication failed, arguments do not match.\n"));
#endif
free (uri);
return MHD_NO;
}
}
free (uri);
return (0 == strcmp (response,
da->sessionkey))
? MHD_YES
: MHD_NO;
}
}
/**
* Authenticates the authorization header sent by the client.
* Uses #MHD_DIGEST_ALG_MD5 (for now, for backwards-compatibility).
* Note that this MAY change to #MHD_DIGEST_ALG_AUTO in the future.
* If you want to be sure you get MD5, use #MHD_digest_auth_check2
* and specify MD5 explicitly.
*
* @param connection The MHD connection structure
* @param realm The realm presented to the client
* @param username The username needs to be authenticated
* @param password The password used in the authentication
* @param nonce_timeout The amount of time for a nonce to be
* invalid in seconds
* @return #MHD_YES if authenticated, #MHD_NO if not,
* #MHD_INVALID_NONCE if nonce is invalid
* @ingroup authentication
*/
_MHD_EXTERN int
MHD_digest_auth_check (struct MHD_Connection *connection,
const char *realm,
const char *username,
const char *password,
unsigned int nonce_timeout)
{
return MHD_digest_auth_check2 (connection,
realm,
username,
password,
nonce_timeout,
MHD_DIGEST_ALG_MD5);
}
/**
* Setup digest authentication data structures (on the
* stack, hence must be done inline!). Initializes a
* "struct DigestAlgorithm da" for algorithm @a algo.
*
* @param algo digest algorithm to provide
* @param da data structure to setup
*/
#define SETUP_DA(algo,da) \
union { \
struct MD5Context md5; \
struct sha256_ctx sha256; \
} ctx; \
union { \
char md5[MD5_DIGEST_SIZE * 2 + 1]; \
char sha256[SHA256_DIGEST_SIZE * 2 + 1]; \
} skey; \
struct DigestAlgorithm da; \
\
do { \
switch (algo) { \
case MHD_DIGEST_ALG_MD5: \
da.digest_size = MD5_DIGEST_SIZE; \
da.ctx = &ctx.md5; \
da.alg = "md5"; \
da.sessionkey = skey.md5; \
da.init = &MHD_MD5Init; \
da.update = &MHD_MD5Update; \
da.digest = &MHD_MD5Final; \
break; \
case MHD_DIGEST_ALG_AUTO: \
/* auto == SHA256, fall-though thus intentional! */ \
case MHD_DIGEST_ALG_SHA256: \
da.digest_size = SHA256_DIGEST_SIZE; \
da.ctx = &ctx.sha256; \
da.alg = "sha-256"; \
da.sessionkey = skey.sha256; \
da.init = &MHD_SHA256_init; \
da.update = &MHD_SHA256_update; \
da.digest = &MHD_SHA256_finish; \
break; \
default: \
da.digest_size = 0; \
mhd_assert (false); \
break; \
} \
} while (0)
/**
* Authenticates the authorization header sent by the client.
*
* @param connection The MHD connection structure
* @param realm The realm presented to the client
* @param username The username needs to be authenticated
* @param password The password used in the authentication
* @param nonce_timeout The amount of time for a nonce to be
* invalid in seconds
* @param algo digest algorithms allowed for verification
* @return #MHD_YES if authenticated, #MHD_NO if not,
* #MHD_INVALID_NONCE if nonce is invalid
* @ingroup authentication
*/
_MHD_EXTERN int
MHD_digest_auth_check2 (struct MHD_Connection *connection,
const char *realm,
const char *username,
const char *password,
unsigned int nonce_timeout,
enum MHD_DigestAuthAlgorithm algo)
{
SETUP_DA (algo, da);
mhd_assert (NULL != password);
return digest_auth_check_all (connection,
&da,
realm,
username,
password,
NULL,
nonce_timeout);
}
/**
* Authenticates the authorization header sent by the client.
*
* @param connection The MHD connection structure
* @param realm The realm presented to the client
* @param username The username needs to be authenticated
* @param digest An `unsigned char *' pointer to the binary MD5 sum
* for the precalculated hash value "username:realm:password"
* of #MHD_MD5_DIGEST_SIZE bytes
* @param digest_size number of bytes in @a digest
* @param nonce_timeout The amount of time for a nonce to be
* invalid in seconds
* @param algo digest algorithms allowed for verification
* @return #MHD_YES if authenticated, #MHD_NO if not,
* #MHD_INVALID_NONCE if nonce is invalid
* @ingroup authentication
*/
_MHD_EXTERN int
MHD_digest_auth_check_digest2 (struct MHD_Connection *connection,
const char *realm,
const char *username,
const uint8_t *digest,
size_t digest_size,
unsigned int nonce_timeout,
enum MHD_DigestAuthAlgorithm algo)
{
SETUP_DA (algo, da);
mhd_assert (NULL != digest);
if (da.digest_size != digest_size)
MHD_PANIC (_ ("Digest size mismatch.\n")); /* API violation! */
return digest_auth_check_all (connection,
&da,
realm,
username,
NULL,
digest,
nonce_timeout);
}
/**
* Authenticates the authorization header sent by the client.
* Uses #MHD_DIGEST_ALG_MD5 (required, as @a digest is of fixed
* size).
*
* @param connection The MHD connection structure
* @param realm The realm presented to the client
* @param username The username needs to be authenticated
* @param digest An `unsigned char *' pointer to the binary digest
* for the precalculated hash value "username:realm:password"
* of @a digest_size bytes
* @param nonce_timeout The amount of time for a nonce to be
* invalid in seconds
* @return #MHD_YES if authenticated, #MHD_NO if not,
* #MHD_INVALID_NONCE if nonce is invalid
* @ingroup authentication
*/
_MHD_EXTERN int
MHD_digest_auth_check_digest (struct MHD_Connection *connection,
const char *realm,
const char *username,
const uint8_t digest[MHD_MD5_DIGEST_SIZE],
unsigned int nonce_timeout)
{
return MHD_digest_auth_check_digest2 (connection,
realm,
username,
digest,
MHD_MD5_DIGEST_SIZE,
nonce_timeout,
MHD_DIGEST_ALG_MD5);
}
/**
* Queues a response to request authentication from the client
*
* @param connection The MHD connection structure
* @param realm the realm presented to the client
* @param opaque string to user for opaque value
* @param response reply to send; should contain the "access denied"
* body; note that this function will set the "WWW Authenticate"
* header and that the caller should not do this
* @param signal_stale #MHD_YES if the nonce is invalid to add
* 'stale=true' to the authentication header
* @param algo digest algorithm to use
* @return #MHD_YES on success, #MHD_NO otherwise
* @ingroup authentication
*/
enum MHD_Result
MHD_queue_auth_fail_response2 (struct MHD_Connection *connection,
const char *realm,
const char *opaque,
struct MHD_Response *response,
int signal_stale,
enum MHD_DigestAuthAlgorithm algo)
{
int ret;
int hlen;
SETUP_DA (algo, da);
{
char nonce[NONCE_STD_LEN (VLA_ARRAY_LEN_DIGEST (da.digest_size)) + 1];
VLA_CHECK_LEN_DIGEST (da.digest_size);
/* Generating the server nonce */
calculate_nonce ((uint32_t) MHD_monotonic_sec_counter (),
connection->method,
connection->daemon->digest_auth_random,
connection->daemon->digest_auth_rand_size,
connection->url,
realm,
&da,
nonce);
if (MHD_NO ==
check_nonce_nc (connection,
nonce,
0))
{
#ifdef HAVE_MESSAGES
MHD_DLOG (connection->daemon,
_ (
"Could not register nonce (is the nonce array size zero?).\n"));
#endif
return MHD_NO;
}
/* Building the authentication header */
hlen = MHD_snprintf_ (NULL,
0,
"Digest realm=\"%s\",qop=\"auth\",nonce=\"%s\",opaque=\"%s\",algorithm=%s%s",
realm,
nonce,
opaque,
da.alg,
signal_stale
? ",stale=\"true\""
: "");
if (hlen > 0)
{
char *header;
header = MHD_calloc_ (1,
hlen + 1);
if (NULL == header)
{
#ifdef HAVE_MESSAGES
MHD_DLOG (connection->daemon,
_ ("Failed to allocate memory for auth response header.\n"));
#endif /* HAVE_MESSAGES */
return MHD_NO;
}
if (MHD_snprintf_ (header,
hlen + 1,
"Digest realm=\"%s\",qop=\"auth\",nonce=\"%s\",opaque=\"%s\",algorithm=%s%s",
realm,
nonce,
opaque,
da.alg,
signal_stale
? ",stale=\"true\""
: "") == hlen)
ret = MHD_add_response_header (response,
MHD_HTTP_HEADER_WWW_AUTHENTICATE,
header);
else
ret = MHD_NO;
#if 0
if ( (MHD_NO != ret) && (AND in state : 100 continue aborting ...))
ret = MHD_add_response_header (response,
MHD_HTTP_HEADER_CONNECTION,
"close");
#endif
free (header);
}
else
ret = MHD_NO;
}
if (MHD_NO != ret)
{
ret = MHD_queue_response (connection,
MHD_HTTP_UNAUTHORIZED,
response);
}
else
{
#ifdef HAVE_MESSAGES
MHD_DLOG (connection->daemon,
_ ("Failed to add Digest auth header.\n"));
#endif /* HAVE_MESSAGES */
}
return ret;
}
/**
* Queues a response to request authentication from the client.
* For now uses MD5 (for backwards-compatibility). Still, if you
* need to be sure, use #MHD_queue_auth_fail_response2().
*
* @param connection The MHD connection structure
* @param realm the realm presented to the client
* @param opaque string to user for opaque value
* @param response reply to send; should contain the "access denied"
* body; note that this function will set the "WWW Authenticate"
* header and that the caller should not do this
* @param signal_stale #MHD_YES if the nonce is invalid to add
* 'stale=true' to the authentication header
* @return #MHD_YES on success, #MHD_NO otherwise
* @ingroup authentication
* @deprecated use MHD_queue_auth_fail_response2()
*/
enum MHD_Result
MHD_queue_auth_fail_response (struct MHD_Connection *connection,
const char *realm,
const char *opaque,
struct MHD_Response *response,
int signal_stale)
{
return MHD_queue_auth_fail_response2 (connection,
realm,
opaque,
response,
signal_stale,
MHD_DIGEST_ALG_MD5);
}
/* end of digestauth.c */
|