How to build squid authentication helpers

Build your own authentication helper using the language of your choice

Download the whole article as PDF

Write a full post in response to this!


Have you ever tried to figure out how to make Squid authenticate users according to your own exotic rules? Users are in a DB? Are you using an ActiveDirectory? Users/passwords are authenticated by a java class? Everything is possible. Here I intend to explain how to make your own custom authentication helpers so you can develop your own routines for your own requirements.

Squid

Squid is such a wonderful HTTP cache server. It’s stable, fast, highly customizable, and you barely notice it when it’s working (oh and did I say it’s free as in freedom?).

It comes with a number of authentication helpers, but there are times when these helpers are not enough. Sometimes you have authentication requirements exotic enough that make those default helpers useless.

The need

Suppose you have to do a little checking: you have users/passwords in a MySQL DB table. To make it a little more exotic, passwords are not directly stored, but MD5s instead. Suppose that you also want the allowed users to be listed in a text file in your file system and, finally, make an LDAP request to see if there’s an item in the directory that matches usernames by the field named “thisCrazyField”. If all that fails, the user/password can be the pair “foo/bar” (a backdoor… just in case you want to see some things that are better left anonymous in the Squid logs!). I am sure no default helper will be able to pull it off.

Before you waste more brainpower trying to figure out when your boss is going to fire you because you couldn’t find a way to make this authentication scheme work with Squid (or any other HTTP cache solution for that matter), you should know that you can make a stand-alone program that can tell if a user is permitted to go through or not. Easy!

Authentication helpers

What a helper does (even a default one) is very simple: it reads username/password pairs from Standard Input one pair at a time in a single line of text, and writes a single line of text to Standard Output that either says “OK” (for a user that can go through) or “ERR” (in case of problems)—that’s it. The helper has to repeat this action in an endless cycle. Username and passwords are encoded using the character encoding described in RFC 1738 (section 2.2) and are separated by a white space.

What a helper does (even default ones) is very simple

Say I want to make a helper in PHP that will check if the user/password is one of the following pairs:

  • hello/world
  • foo/bar

Here’s the PHP code:

<?
if (! defined(STDIN)) {
        define("STDIN", fopen("php://stdin", "r"));
}
while (!feof(STDIN)) {
        $line = trim(fgets(STDIN));
        $fields = explode(' ', $line);
        $username = rawurldecode($fields[0]); //1738
        $password = rawurldecode($fields[1]); //1738
        if ($username == 'hello' 
            and $password == 'world') {
                fwrite(STDOUT, "OK\n");
        } else if ($username == 'fo'
            and $password == 'bar') {
                fwrite(STDOUT, "OK\n");
        } else {
                // failed miserably
                fwrite(STDOUT, "ERR\n");
        }
}
?>

That’s it! I’ve just created a PHP-based Squid helper. Feel free to use any tool you want, be it bash, python, Perl or any other language you like. The only requirement is that the language is able to read from the standard input and write to the standard output (if you want to use bash, be careful to avoid making passwords visible with a ps ax).

Testing your masterpiece

Now comes the testing part. You have to act the same way Squid would have to: start the script and interact with it passing username/password pairs. If it outputs “OK” or “ERR” as wanted, then your helper is done. Here’s a demonstration of the helper I just made:

$ php squid_helper.php
hello world
OK
foo bar
ERR

Oops! “foo/bar” is not okay. Go to the source code of the helper. See what’s going on? I wrote == '**fo**' instead of == '**foo**'. Correct it in the source code and try all over again:

Don't miss out on the other pages!
12next ›last »

Write a full post in response to this!

Download the files attached with this article.

Similar articles

0

Do you like this post?
Vote for it!

Copyright information

This article is made available under the "Attribution" Creative Commons License 3.0 available from http://creativecommons.org/licenses/by/3.0/.

Biography

Edmundo Carmona: Edmundo is a Venezuelan Computer Engineer. He is working as a Freelance Java Developer in Colombia since very recently. He has also been a GNU/Linux user and consultant for several years. After years of being retired from music, he's working right now to regain his classical flute skills.

dorgan's picture

AWSOME

Submitted by dorgan on Tue, 2007-06-05 15:46.

Vote!
0

This article rocks and will allow me to have one less things to integrate. Thank you soo much.

Edmundo Carmona's picture

I forgot to mention...

Submitted by Edmundo Carmona on Tue, 2007-06-05 22:26.

Vote!
0

...that in the downloads of the article is a helper to authenticate against ActiveDirectory as a real example.

And thanks for that comment!

Glad to be helpful (even more if there are some ISA servers to be replaced as a side effect of the article :-D).

valen_willie's picture

This is alternative to NoCat, I suppose

Submitted by valen_willie on Wed, 2007-06-06 01:17.

Vote!
0

Excellent article. My company is working on providing Internet pre-paid system to miners who are in the middle of nowhere. The only backhaul we have is Satellite, so we have to treasure our bandwidth. We are tinkling with NoCat at the moment. This article opens up a new possibility of a whole new system all together. Of course, we have to think of how to block all traffics that squid cannot proxy, or else there will be holes in this system (`iptables' to the rescue!). Also, how to tunnel other traffics via HTTP.

omid mohajerani's picture

Problem with your Script

Submitted by omid mohajerani (not verified) on Sat, 2007-07-14 09:18.

Vote!
0

hi
first thank you for your nice article . I have a problem with the script
when i want to run it ( /bin/php /etc/squid/script.php)
it says :

Constant STDIN already defined in /etc/squid/script.php on line 3

please help me.
best regards

Edmundo Carmona's picture

That's a PHP problem

Submitted by Edmundo Carmona on Mon, 2007-07-16 01:20.

Vote!
0

I thought the if (! defined()) would avoid that (at least, it does avoid that problem over here).

Make sure you included the "!" in the conditional on line 2. If you did, that'd be weird... but anyway it seems that your "PHP machine" already has STDIN defined, so you can comment line 3, where it's "redefined"... or remove that whole checking section altogether (the conditional and definition of STDIN).

Hope that works.

Anonymous visitor's picture

problem

Submitted by Anonymous visitor (not verified) on Tue, 2007-07-17 10:12.

Vote!
0

i have problem when using this document. this is the error :
The basicauthenticator helpers are crashing too rapidly, need help!

Edmundo Carmona's picture

sounds like...

Submitted by Edmundo Carmona on Tue, 2007-07-17 17:12.

Vote!
0

sounds like your program is crashing right after squid starts it (or them, if you have many children). Did you test it as a standalone console application before using it with squid to see that it receives the username/password pair and replies with OK/ERR in an infinite cycle?

omid mohajerani's picture

Undefined Offset

Submitted by omid mohajerani (not verified) on Wed, 2007-07-18 06:52.

Vote!
0

first tanx for your answer ; I have delete that line and now my script( ofcourse yours ) is like this

<?
while (!feof(STDIN)) {
$line = trim(fgets(STDIN));
$fields = explode(' ', $line);
$username = rawurldecode($fields[0]); //1738
$password = rawurldecode($fields[1]); //1738
if ($username == 'hello'
and $password == 'world') {
fwrite(STDOUT, "OK\n");
} else if ($username == 'fo'
and $password == 'bar') {
fwrite(STDOUT, "OK\n");
} else {
// failed miserably
fwrite(STDOUT, "ERR\n");
}
}
?>

and now result of excuting /bin/php script.php is :(of course when i enter a string)

PHP Notice: Undefined offset: 1 in /omid/omid.php on line 10
ERR

any suggestion ?

Edmundo Carmona's picture

email me

Submitted by Edmundo Carmona on Thu, 2007-07-19 13:47.

Vote!
0

Why don't you email me? I just copied (verbatim) your script and tried it over here and it worked:

$ php prueba.php
hello world
OK
foo
ERR
foo bar
ERR
fo bar
OK
it's ok
ERR

Maybe the problem is here:
$ php -version
PHP 5.2.3-1ubuntu2 (cli) (built: Jul 4 2007 16:13:07)
Copyright (c) 1997-2007 The PHP Group
Zend Engine v2.2.0, Copyright (c) 1998-2007 Zend Technologies

Anyway, email me so we can take a closer look at what's going on. eantoranz at google's public mail service, you know, right? :-D

Edmundo Carmona's picture

Solved Omid's problem

Submitted by Edmundo Carmona on Fri, 2007-07-20 20:20.

Vote!
0

The problem is the define call. I have the fopen() right in the define, and it fails that way. If you do the fopen and save the result in a temporary variable, it works.

Try with this:

if (! defined(STDIN)) {
$temp = fopen("php://stdin", "r");
define("STDIN", $temp);
}

It worked with version 5.1.2 that way.

It worked with 5.2.3 the original way... I guess it's a bug in 5.1.2

AHMED.S's picture

Problem with script on Windows 2003 AD

Submitted by AHMED.S (not verified) on Fri, 2007-09-14 09:16.

Vote!
0

Thanks for your wonderful article. I am having problems with your script. I believe it is due to the fact that my windows 2003 AD requires authentication to do any LDAP binds. I have another php LDAP application that connects to my AD successfully as it has a variable to configure a user account to connect to the AD with.

Can you please tell me how I can edit your script to bind to ldap using a username and password?

thanks

Edmundo Carmona's picture

Did you see the attachments?

Submitted by Edmundo Carmona on Sun, 2007-09-16 16:47.

Vote!
0

Ahmed, in the article's attachments, there's a PHP script that authenticates against AD through LDAP, and it binds to AD using the username/password provided by squid. Are you having problems with that script? Email me if you have any problems: eantoranz at gmail dot com.

Tobias K.'s picture

Transmitting username and password as cleartext?

Submitted by Tobias K. (not verified) on Tue, 2007-09-25 18:44.

Vote!
0

Thanks a lot for your nice article and for writing for the freesoftwaremagazine.

In many environments the transmission of usernames and passwords as cleartext is not acceptable.

Do you haven an idea of how to solve this problem an transmit the authorization data between client and proxy encrypted?

Regards.
Tobias

Edmundo Carmona's picture

There are some other methods

Submitted by Edmundo Carmona on Wed, 2007-09-26 13:02.

Vote!
0

If you check my example (and the attached script), I always used the "basic" method. However, there are some other methods: digest, ntlm, negociate, so don't stick with basic if you want to do it some other way.

As I'm reading squid.conf's details of each method, helpers will interact with squid in different ways, so take a close look at that.