From: Amos Jeffries Date: Sun, 7 Dec 2014 15:06:43 +0000 (-0800) Subject: ext_wbinfo_group_acl: Update man(8) documentation X-Git-Tag: merge-candidate-3-v1~447 X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=eb0c51fe3c8b8c1c976ef9a8146169dd5bbb3114;p=thirdparty%2Fsquid.git ext_wbinfo_group_acl: Update man(8) documentation --- diff --git a/helpers/external_acl/wbinfo_group/Makefile.am b/helpers/external_acl/wbinfo_group/Makefile.am index 9c83ccaf5f..1193289fa5 100644 --- a/helpers/external_acl/wbinfo_group/Makefile.am +++ b/helpers/external_acl/wbinfo_group/Makefile.am @@ -7,16 +7,17 @@ include $(top_srcdir)/src/Common.am -libexec_SCRIPTS = ext_wbinfo_group_acl -EXTRA_DIST = ext_wbinfo_group_acl.pl.in required.m4 +libexec_SCRIPTS= ext_wbinfo_group_acl +man_MANS= ext_wbinfo_group_acl.8 +EXTRA_DIST= \ + ext_wbinfo_group_acl.8 + ext_wbinfo_group_acl.pl.in \ + required.m4 ext_wbinfo_group_acl: ext_wbinfo_group_acl.pl.in $(subst_perlshell) -EXTRA_DIST += ext_wbinfo_group_acl.8 -man_MANS = ext_wbinfo_group_acl.8 - -ext_wbinfo_group_acl.8: ext_wbinfo_group_acl.pl.in - pod2man $(srcdir)/ext_wbinfo_group_acl.pl.in ext_wbinfo_group_acl.8 +ext_wbinfo_group_acl.8: ext_wbinfo_group_acl + pod2man ext_wbinfo_group_acl ext_wbinfo_group_acl.8 CLEANFILES += ext_wbinfo_group_acl.8 ext_wbinfo_group_acl diff --git a/helpers/external_acl/wbinfo_group/ext_wbinfo_group_acl.pl.in b/helpers/external_acl/wbinfo_group/ext_wbinfo_group_acl.pl.in index 9faa63a2f3..d6389baf79 100755 --- a/helpers/external_acl/wbinfo_group/ext_wbinfo_group_acl.pl.in +++ b/helpers/external_acl/wbinfo_group/ext_wbinfo_group_acl.pl.in @@ -1,55 +1,23 @@ #!@PERL@ -w -# -## Copyright (C) 1996-2014 The Squid Software Foundation and contributors -## -## Squid software is distributed under GPLv2+ license and includes -## contributions from numerous individuals and organizations. -## Please see the COPYING and CONTRIBUTORS files for details. -## -# -# external_acl helper to Squid to verify NT Domain group -# membership using wbinfo -# -# This program is put in the public domain by Jerry Murdock -# . It 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. -# -# Author: -# Jerry Murdock -# -# Version history: -# 2010-08-27 Hank Hampel -# Add Kerberos to NTLM conversion of credentials (-K) -# -# 2005-12-26 Guido Serassio -# Add '-d' command line debugging option -# -# 2005-12-24 Guido Serassio -# Fix for wbinfo from Samba 3.0.21 -# -# 2004-08-15 Henrik Nordstrom -# Helper protocol changed to URL escaped in Squid-3.0 -# -# 2005-06-28 Arno Streuli -# Add multi group check -# -# 2002-07-05 Jerry Murdock -# Initial release + +use strict; +use Pod::Usage; +use Getopt::Long; + =pod =head1 NAME -ext_wbinfo_group_acl - external ACL helper for Squid to verify NT Domain group membership using wbinfo. + ext_wbinfo_group_acl - external ACL helper for Squid to verify NT Domain group membership using wbinfo. =head1 SYNOPSIS -ext_wbinfo_group_acl [-dh] + ext_wbinfo_group_acl [-dhK] =head1 DESCRIPTION -ext_wbinfo_group_acl is an installed executable script. -It uses wbinfo from Samba to lookup group membership of logged in users. +B is an installed executable script. +It uses B from Samba to lookup group membership of logged in users. This helper must be used in with an authentication scheme (typically Basic or NTLM) based on Windows NT/2000 domain users. @@ -60,19 +28,31 @@ username. =head1 OPTIONS - -d Write debug info to stderr. - -h Print the help. - -K downgrade Kerberos credentials to NTLM. +=over 12 + +=item B<-d> + +Write debug info to stderr. + +=item B<-h> + +Print the help. + +=item B<-K> + +Downgrade Kerberos credentials to NTLM. + +=back =head1 CONFIGURATION - external_acl_type wbinfo_check %LOGIN /path/to/ext_wbinfo_group_acl - acl allowed_group external wbinfo_check Group1 Group2 - http_access allow allowed_group + external_acl_type wbinfo_check %LOGIN /path/to/ext_wbinfo_group_acl + acl allowed_group external wbinfo_check Group1 Group2 + http_access allow allowed_group If the local perl interpreter is in a unusual location it may need to be added: - external_acl_type wbinfo_check %LOGIN /path/to/perl /path/to/ext_wbinfo_group_acl + external_acl_type wbinfo_check %LOGIN /path/to/perl /path/to/ext_wbinfo_group_acl =head1 AUTHOR @@ -82,15 +62,20 @@ This manual was written by Amos Jeffries =head1 COPYRIGHT -This program is put in the public domain by Jerry Murdock -. It 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. + * Copyright (C) 1996-2014 The Squid Software Foundation and contributors + * + * Squid software is distributed under GPLv2+ license and includes + * contributions from numerous individuals and organizations. + * Please see the COPYING and CONTRIBUTORS files for details. + + This program is put in the public domain by Jerry Murdock + . It 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. =head1 QUESTIONS -Questions on the usage of this program can be sent to the -Squid Users mailing list +Questions on the usage of this program can be sent to the I> =head1 REPORTING BUGS @@ -99,10 +84,9 @@ See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you ne Report bugs or bug fixes using http://bugs.squid-cache.org/ -Report serious security bugs to Squid Bugs +Report serious security bugs to I> -Report ideas for new improvements to the -Squid Developers mailing list +Report ideas for new improvements to the I> =head1 SEE ALSO @@ -112,6 +96,26 @@ The Squid Configuration Manual http://www.squid-cache.org/Doc/config/ =cut +# +# Version history: +# 2010-08-27 Hank Hampel +# Add Kerberos to NTLM conversion of credentials (-K) +# +# 2005-12-26 Guido Serassio +# Add '-d' command line debugging option +# +# 2005-12-24 Guido Serassio +# Fix for wbinfo from Samba 3.0.21 +# +# 2004-08-15 Henrik Nordstrom +# Helper protocol changed to URL escaped in Squid-3.0 +# +# 2005-06-28 Arno Streuli +# Add multi group check +# +# 2002-07-05 Jerry Murdock +# Initial release + # # Globals #