diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2013-07-26 12:22:11 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2013-07-26 12:25:35 +0300 |
commit | 887f0c1ae86318af0ffcc722bed8457888542db9 (patch) | |
tree | 80015fd53dae758a9433cdd4782a23510d8f697d | |
parent | 18bc67cf4e8e6e453a02fc01128841957b521d19 (diff) | |
download | vmod-basicauth-887f0c1ae86318af0ffcc722bed8457888542db9.tar.gz vmod-basicauth-887f0c1ae86318af0ffcc722bed8457888542db9.tar.bz2 |
Update docs. Fix project name discrepancies.
* src/vmod_basicauth.3: Include vmod-basicauth.3
* src/vmod-basicauth.3: New file.
* configure.ac: Update
* src/Makefile.am: Update
* src/vmod_basicauth.c: Update
-rw-r--r-- | Makefile.am | 8 | ||||
-rw-r--r-- | NEWS | 4 | ||||
-rw-r--r-- | configure.ac | 10 | ||||
-rw-r--r-- | src/Makefile.am | 18 | ||||
-rw-r--r-- | src/vmod-basicauth.3 | 84 | ||||
-rw-r--r-- | src/vmod_basicauth.3 | 84 | ||||
-rw-r--r-- | src/vmod_basicauth.c | 8 |
7 files changed, 118 insertions, 98 deletions
diff --git a/Makefile.am b/Makefile.am index 424ab6a..2e97059 100644 --- a/Makefile.am +++ b/Makefile.am | |||
@@ -1,18 +1,18 @@ | |||
1 | # This file is part of libvmod_basicauth | 1 | # This file is part of vmod-basicauth |
2 | # Copyright (C) 2013 Sergey Poznyakoff | 2 | # Copyright (C) 2013 Sergey Poznyakoff |
3 | # | 3 | # |
4 | # Libvmod_basicauth is free software; you can redistribute it and/or modify | 4 | # Vmod-basicauth is free software; you can redistribute it and/or modify |
5 | # it under the terms of the GNU General Public License as published by | 5 | # it under the terms of the GNU General Public License as published by |
6 | # the Free Software Foundation; either version 3, or (at your option) | 6 | # the Free Software Foundation; either version 3, or (at your option) |
7 | # any later version. | 7 | # any later version. |
8 | # | 8 | # |
9 | # Libvmod_basicauth is distributed in the hope that it will be useful, | 9 | # Vmod-basicauth is distributed in the hope that it will be useful, |
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 | # GNU General Public License for more details. | 12 | # GNU General Public License for more details. |
13 | # | 13 | # |
14 | # You should have received a copy of the GNU General Public License | 14 | # You should have received a copy of the GNU General Public License |
15 | # along with libvmod_basicauth. If not, see <http://www.gnu.org/licenses/>. | 15 | # along with vmod-basicauth. If not, see <http://www.gnu.org/licenses/>. |
16 | ACLOCAL_AMFLAGS = -I m4 | 16 | ACLOCAL_AMFLAGS = -I m4 |
17 | 17 | ||
18 | SUBDIRS = src tests | 18 | SUBDIRS = src tests |
@@ -1,9 +1,11 @@ | |||
1 | Vmod-basicauth NEWS -- history of user-visible changes. 2013-07-09 | 1 | Vmod-basicauth NEWS -- history of user-visible changes. 2013-07-26 |
2 | Copyright (C) 2013 Sergey Poznyakoff | 2 | Copyright (C) 2013 Sergey Poznyakoff |
3 | See the end of file for copying conditions. | 3 | See the end of file for copying conditions. |
4 | 4 | ||
5 | Please send Vmod-basicauth bug reports to <gray@gnu.org> | 5 | Please send Vmod-basicauth bug reports to <gray@gnu.org> |
6 | 6 | ||
7 | Version 1.1.90 (Git) | ||
8 | |||
7 | Version 1.1, 2013-07-09 | 9 | Version 1.1, 2013-07-09 |
8 | 10 | ||
9 | Implement SHA1 passwords. | 11 | Implement SHA1 passwords. |
diff --git a/configure.ac b/configure.ac index 83ef69e..3ec841b 100644 --- a/configure.ac +++ b/configure.ac | |||
@@ -1,20 +1,20 @@ | |||
1 | # This file is part of libvmod_basicauth -*- autoconf -*- | 1 | # This file is part of vmod-basicauth -*- autoconf -*- |
2 | # Copyright (C) 2013 Sergey Poznyakoff | 2 | # Copyright (C) 2013 Sergey Poznyakoff |
3 | # | 3 | # |
4 | # Libvmod_basicauth is free software; you can redistribute it and/or modify | 4 | # Vmod-basicauth is free software; you can redistribute it and/or modify |
5 | # it under the terms of the GNU General Public License as published by | 5 | # it under the terms of the GNU General Public License as published by |
6 | # the Free Software Foundation; either version 3, or (at your option) | 6 | # the Free Software Foundation; either version 3, or (at your option) |
7 | # any later version. | 7 | # any later version. |
8 | # | 8 | # |
9 | # Libvmod_basicauth is distributed in the hope that it will be useful, | 9 | # Vmod-basicauth is distributed in the hope that it will be useful, |
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 | # GNU General Public License for more details. | 12 | # GNU General Public License for more details. |
13 | # | 13 | # |
14 | # You should have received a copy of the GNU General Public License | 14 | # You should have received a copy of the GNU General Public License |
15 | # along with libvmod_basicauth. If not, see <http://www.gnu.org/licenses/>. | 15 | # along with vmod-basicauth. If not, see <http://www.gnu.org/licenses/>. |
16 | AC_PREREQ(2.69) | 16 | AC_PREREQ(2.69) |
17 | AC_INIT([libvmod-basicauth], 1.1, [gray@gnu.org]) | 17 | AC_INIT([vmod-basicauth], 1.1.90, [gray@gnu.org]) |
18 | AC_CONFIG_AUX_DIR([build-aux]) | 18 | AC_CONFIG_AUX_DIR([build-aux]) |
19 | AC_CONFIG_MACRO_DIR([m4]) | 19 | AC_CONFIG_MACRO_DIR([m4]) |
20 | AC_CONFIG_SRCDIR(src/vmod_basicauth.vcc) | 20 | AC_CONFIG_SRCDIR(src/vmod_basicauth.vcc) |
diff --git a/src/Makefile.am b/src/Makefile.am index e5e6bc1..983bee9 100644 --- a/src/Makefile.am +++ b/src/Makefile.am | |||
@@ -1,6 +1,22 @@ | |||
1 | # This file is part of vmod-basicauth | ||
2 | # Copyright (C) 2013 Sergey Poznyakoff | ||
3 | # | ||
4 | # Vmod-basicauth is free software; you can redistribute it and/or modify | ||
5 | # it under the terms of the GNU General Public License as published by | ||
6 | # the Free Software Foundation; either version 3, or (at your option) | ||
7 | # any later version. | ||
8 | # | ||
9 | # Vmod-basicauth is distributed in the hope that it will be useful, | ||
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | # GNU General Public License for more details. | ||
13 | # | ||
14 | # You should have received a copy of the GNU General Public License | ||
15 | # along with vmod-basicauth. If not, see <http://www.gnu.org/licenses/>. | ||
16 | |||
1 | AM_CPPFLAGS = -I$(VARNISHSRC)/include -I$(VARNISHSRC) | 17 | AM_CPPFLAGS = -I$(VARNISHSRC)/include -I$(VARNISHSRC) |
2 | 18 | ||
3 | dist_man_MANS = vmod_basicauth.3 | 19 | dist_man_MANS = vmod-basicauth.3 vmod_basicauth.3 |
4 | 20 | ||
5 | vmoddir = $(VMODDIR) | 21 | vmoddir = $(VMODDIR) |
6 | vmod_LTLIBRARIES = libvmod_basicauth.la | 22 | vmod_LTLIBRARIES = libvmod_basicauth.la |
diff --git a/src/vmod-basicauth.3 b/src/vmod-basicauth.3 new file mode 100644 index 0000000..31990c0 --- /dev/null +++ b/src/vmod-basicauth.3 | |||
@@ -0,0 +1,84 @@ | |||
1 | .\" This file is part of Vmod-basicauth -*- nroff -*- | ||
2 | .\" Copyright (C) 2013 Sergey Poznyakoff | ||
3 | .\" | ||
4 | .\" Vmod-basicauth is free software; you can redistribute it and/or modify | ||
5 | .\" it under the terms of the GNU General Public License as published by | ||
6 | .\" the Free Software Foundation; either version 3, or (at your option) | ||
7 | .\" any later version. | ||
8 | .\" | ||
9 | .\" Vmod-basicauth is distributed in the hope that it will be useful, | ||
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | .\" GNU General Public License for more details. | ||
13 | .\" | ||
14 | .\" You should have received a copy of the GNU General Public License | ||
15 | .\" along with vmod-basicauth. If not, see <http://www.gnu.org/licenses/>. | ||
16 | .TH VMOD-BASICAUTH 1 "July 8, 2013" "VMOD-BASICAUTH" "User Reference" | ||
17 | .SH NAME | ||
18 | vmod-basicauth \- Basic HTTP authentication | ||
19 | .SH SYNOPSIS | ||
20 | .B import basicauth; | ||
21 | |||
22 | .BI "BOOL basicauth.match(STRING " passfile ", STRING " authstr ); | ||
23 | .SH DESCRIPTION | ||
24 | The | ||
25 | .B vmod-basicauth | ||
26 | module implements basic HTTP authentication against the password file | ||
27 | created using the | ||
28 | .BR htpasswd (1) | ||
29 | command. | ||
30 | .PP | ||
31 | Four kinds of password hashes are supported: | ||
32 | Apache MD5 (\fB$apr1$\fR), | ||
33 | .BR crypt (3), | ||
34 | .BR SHA1 , | ||
35 | and plaintext. | ||
36 | .PP | ||
37 | The \fBmatch\fR function returns \fBTRUE\fR or \fBFALSE\fR depending on | ||
38 | whether the authentication succeeds or not. The \fIpassfile\fR argument | ||
39 | supplies the name of the password file to use. The \fIauthstr\fR argument | ||
40 | is the authentication string (normally, the value of the | ||
41 | \fBAuthorization\fR HTTP header. | ||
42 | .PP | ||
43 | .SS Example | ||
44 | .sp | ||
45 | .nf | ||
46 | .in +2 | ||
47 | if (!basicauth.match("/var/www/.htpasswd", req.http.Authorization)) { | ||
48 | error 401 "Restricted"; | ||
49 | } | ||
50 | .in | ||
51 | .fi | ||
52 | .\" The MANCGI variable is set by man.cgi script on Ulysses. | ||
53 | .\" The download.inc file contains the default DOWNLOAD section | ||
54 | .\" for man-based doc pages. | ||
55 | .if "\V[MANCGI]"WEBDOC" \{\ | ||
56 | . ds package vmod-basicauth | ||
57 | . ds version 1.1 | ||
58 | . so download.inc | ||
59 | \} | ||
60 | .SH "SEE ALSO" | ||
61 | .BR vcl (7), | ||
62 | .BR varnishd (1). | ||
63 | .SH AUTHORS | ||
64 | Sergey Poznyakoff | ||
65 | .SH "BUG REPORTS" | ||
66 | Report bugs to <gray@gnu.org>. | ||
67 | .SH COPYRIGHT | ||
68 | Copyright \(co 2013 Sergey Poznyakoff | ||
69 | .br | ||
70 | .na | ||
71 | License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> | ||
72 | .br | ||
73 | .ad | ||
74 | This is free software: you are free to change and redistribute it. | ||
75 | There is NO WARRANTY, to the extent permitted by law. | ||
76 | .\" Local variables: | ||
77 | .\" eval: (add-hook 'write-file-hooks 'time-stamp) | ||
78 | .\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.-]* [0-9] \"" | ||
79 | .\" time-stamp-format: "%:B %:d, %:y" | ||
80 | .\" time-stamp-end: "\"" | ||
81 | .\" time-stamp-line-limit: 20 | ||
82 | .\" end: | ||
83 | |||
84 | |||
diff --git a/src/vmod_basicauth.3 b/src/vmod_basicauth.3 index d7c8934..086f34e 100644 --- a/src/vmod_basicauth.3 +++ b/src/vmod_basicauth.3 | |||
@@ -1,83 +1 @@ | |||
1 | .\" This file is part of libvmod_basicauth -*- nroff -*- | .so man3/vmod-basicauth.3 | |
2 | .\" Copyright (C) 2013 Sergey Poznyakoff | ||
3 | .\" | ||
4 | .\" Libvmod_basicauth is free software; you can redistribute it and/or modify | ||
5 | .\" it under the terms of the GNU General Public License as published by | ||
6 | .\" the Free Software Foundation; either version 3, or (at your option) | ||
7 | .\" any later version. | ||
8 | .\" | ||
9 | .\" Libvmod_basicauth is distributed in the hope that it will be useful, | ||
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | .\" GNU General Public License for more details. | ||
13 | .\" | ||
14 | .\" You should have received a copy of the GNU General Public License | ||
15 | .\" along with libvmod_basicauth. If not, see <http://www.gnu.org/licenses/>. | ||
16 | .TH VMOD_BASICAUTH 1 "July 8, 2013" "VMOD_BASICAUTH" "User Reference" | ||
17 | .SH NAME | ||
18 | vmod_basica |