ksgi

1
.\"	$Id$
2
.\"
3
.\" Copyright (c) 2016 Kristaps Dzonsons <kristaps@bsd.lv>
4
.\"
5
.\" Permission to use, copy, modify, and distribute this software for any
6
.\" purpose with or without fee is hereby granted, provided that the above
7
.\" copyright notice and this permission notice appear in all copies.
8
.\"
9
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16
.\"
17
.Dd $Mdocdate$
18
.Dt KHTTPDIGEST_VALIDATE 3
19
.Os
20
.Sh NAME
21
.Nm khttpdigest_validate ,
22
.Nm khttpdigest_validatehash
23
.Nd validate an HTTP digest request
24
.Sh LIBRARY
25
.Lb libkcgi
26
.Sh SYNOPSIS
27
.In sys/types.h
28
.In stdarg.h
29
.In stdint.h
30
.In kcgi.h
31
.Ft int
32
.Fo khttpdigest_validate
33
.Fa "struct kreq *req"
34
.Fa "const char *password"
35
.Fc
36
.Ft int
37
.Fo khttpdigest_validatehash
38
.Fa "struct kreq *req"
39
.Fa "const char *hash"
40
.Fc
41
.Sh DESCRIPTION
42
The
43
.Fn khttpdigest_validate
44
and
45
.Fn khttpdigest_validatehash
46
functions validate the given
47
.Fa password
48
(or a pre-combined
49
.Fa hash )
50
with the HTTP digest-authorised request
51
.Fa req
52
as returned by
53
.Xr khttp_parse 3
54
or
55
.Xr khttp_fcgi_parse 3 .
56
It fully implements all components of the digest: QOP, MD5 types, etc.
57
It
58
.Em does not
59
check that the URI component of the digest matches that of the request,
60
as these values are known to be mutable.
61
.Pp
62
The
63
.Fn khttpdigest_validate
64
function will compute a hash from the request and password;
65
.Fn khttpdigest_validatehash
66
operates on a pre-computed hash value.
67
.Sh RETURN VALUES
68
.Fn khttpdigest_validate
69
and
70
.Fn khttpdigest_validatehash
71
will return zero if validation failed, less than zero if the request was
72
not properly set up for HTTP digest validation (no HTTP method, not a
73
digest request, not already authenticated by the web server), or greater
74
than zero if the validation succeeded.
75
.Sh SEE ALSO
76
.Xr kcgi 3 ,
77
.Xr khttp_fcgi_parse 3 ,
78
.Xr khttp_parse 3 ,
79
.Xr khttpbasic_validate 3
80
.Sh AUTHORS
81
The
82
.Fn khttpdigest_validate
83
and
84
.Fn khttpdigest_validatehash
85
functions were written by
86
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
87