From: Amos Jeffries <squid3@treenet.co.nz>
Date: Mon, 19 Dec 2016 10:47:37 +0000 (+1300)
Subject: Drop old Basic Authenticatio docs
X-Git-Tag: M-staged-PR71~333^2~11
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7ffae7829cd71e71361d5716992d520ffb6a40b4;p=thirdparty%2Fsquid.git

Drop old Basic Authenticatio docs

The wiki these days contains a more detailed and correct description of
how Basic auth helpers work in Squid. This old document does not even
describe how the code works, so is no longer useful.
---

diff --git a/doc/Programming-Guide/BasicAuthentication.dox b/doc/Programming-Guide/BasicAuthentication.dox
deleted file mode 100644
index 1e24e1f2cc..0000000000
--- a/doc/Programming-Guide/BasicAuthentication.dox
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright (C) 1996-2016 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.
- */
-
-/**
-\defgroup AuthAPIBasic Basic Authentication
-\ingroup AuthAPI
-
-\par
-Basic authentication provides a username and password.  These
-are written to the authentication module processes on a single
-line, separated by a space:
-\code
-<USERNAME> <PASSWORD>
-\endcode
-
-\par
-	The authentication module process reads username, password pairs
-	on stdin and returns either "OK" or "ERR" on stdout for
-	each input line.
-
-\par
-	The following simple perl script demonstrates how the
-	authentication module works.  This script allows any
-	user named "Dirk" (without checking the password)
-	and allows any user that uses the password "Sekrit":
-
-\code
-#!/usr/bin/perl -w
-$|=1;		# no buffering, important!
-while (<>) {
-        chop;
-        ($u,$p) = split;
-        $ans = &amp;check($u,$p);
-        print "$ans\n";
-}
-
-sub check {
-        local($u,$p) = @_;
-        return 'ERR' unless (defined $p &amp;&amp; defined $u);
-        return 'OK' if ('Dirk' eq $u);
-        return 'OK' if ('Sekrit' eq $p);
-        return 'ERR';
-}
-\endcode
-
- */