-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAUTHENTICATION
1320 lines (1006 loc) · 58.7 KB
/
AUTHENTICATION
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
MRBS Users Authentication
=========================
Principles
==========
User interface
--------------
MRBS pages can be accessed and used, depending on the user's access level.
There are three levels of access in MRBS:
- Level 0 - Unknown user
- Level 1 - Authenticated user
- Level 2 - Administrator
Level 0 users can view most pages, but cannot make any change.
Level 1 users can make bookings, and can change their own bookings.
Level 2 users - The administrators - are allowed to modify other people's
bookings. Administrators also have the ability to add and remove rooms and
areas.
Before accessing a restricted page, MRBS prompts the user for a name and
password. Then it connects to an authentication server, which is responsible
for deciding if the user/password pair is valid. If it is, MRBS then checks if
the name is in its list of administrators. Finally MRBS grants access to the
page at the right level. The name and password are recorded for the duration of
the session, and won't be asked for again.
Configuration
-------------
MRBS authentication configuration is done in file config.inc.php.
This file contains a section for authentication parameters, where several
choices must be made:
- The session management scheme. (How to prompt for a user/password,
and how keep track of it)
- The authentication method. (What kind of server will verify the
user/password validity)
- The list of administrators (not used by the 'db' authentication method)
There are several alternative authentication methods. They differ by the type
of authentication server they can connect to, and by the kind of program used
for communicating with that server. Each method is implemented in a pluggable
module. There are two general categories:
- Internal PHP modules, which connect directly to an authentication
server. These modules may require additional parameter settings in
config.inc.php.
- External programs, that do the same after being invoked by the
special "ext" PHP authentication module.
Internal PHP modules support the following kinds of authentication servers:
LDAP servers; POP3 email servers; IMAP email servers; NIS servers ; NW servers.
In addition, three special internal modules support a local list of users for
one; a local list of users stored in databse for the second; and
authenticating anybody for the other.
External programs support: NT Domain controllers; Netware servers; PAM servers.
Which authentication scheme to choose
=====================================
The right choice for you depends on where your users are:
If they're all in a closed organization (A private company; a university; etc),
then this organization probably already has its own authentication service.
MRBS can connect to several kinds of services, like LDAP servers; NT domain
controllers; Netware servers; pop3 or imap mail servers; etc.
PHP authentication modules
--------------------------
+---------+------------------------+-------------------+------------------------+
|Type |Description |Pros |Cons |
+---------+------------------------+-------------------+------------------------+
|none |Every user is accepted. | | |
| |This was for example the| | |
| |case of the MRBS 1.1 IP | - Very simple to | - No security at all. |
| |address and computer | setup. | |
| |name "authentications". | | |
+---------+------------------------+-------------------+------------------------+
|config |Users are listed in | | |
| |config.inc.php. | | |
| | | - Simple to | - Users cannot update |
| | | setup. | their own password. |
| | | | |
| | | - Not dependant | - Administrators |
| | | on an external | manually set the user |
| | | authentication | passwords, which is |
| | | server, so usable| against normal |
| | | on the Internet. | confidentiality rules.|
| | | | |
+---------+------------------------+-------------------+------------------------+
|db |Users validated using | | |
| |web-based authentication| - Simple to setup| |
| |based on a table in mrbs| | - Does not use |
| |database | - Built in MRBS | existing directory |
| | | but more secure | |
| | | than 'config' | |
| | | | |
| | | - easy to | |
| | | configure | |
+---------+------------------------+-------------------+------------------------+
|db_ext |Users validated using | | |
| |a table in an external | - Uses an | |
| |database | existing | |
| | | authentication | |
| | | database thereby | |
| | | saving directory | |
| | | duplication. | |
| | | | |
| | | - easy to | |
| | | configure | |
| | | | |
+---------+------------------------+-------------------+------------------------+
|ldap |Users validated using | | |
| |LDAP directory services.| | |
| | | - For corporate | - Does not work on the|
| | | intranets using | Internet? |
| | | LDAP directory | |
| | | services. | |
| | | | |
+---------+------------------------+-------------------+------------------------+
|pop3 |Users validated by a | | |
| |POP3 mail server. | | |
| | | - For groups of | - Technically works on|
| | | users all having | the Internet, but it's|
| | | an Email address | unlikely all users of |
| | | on the same | a site will have an |
| | | server. | Email address on the |
| | | | same mail server. |
| | | | |
+---------+------------------------+-------------------+------------------------+
|imap |Users validated by an | | |
| |IMAP mail server. | | |
| | | - For groups of | - Technically works on|
| | | users all having | the Internet, but it's|
| | | an Email address | unlikely all users of |
| | | on the same | a site will have an |
| | | server. | Email address on the |
| | | | same mail server. |
| | | | |
+---------+------------------------+-------------------+------------------------+
|nis |Users validated by NIS | | - This extension is |
| |server (user contrib.) | | not available on |
| | | - ? | Windows platforms. |
| | | | |
+---------+------------------------+-------------------+------------------------+
|nw |Users validated by | | - TThis is only going |
| |Netware server | | to work on Linux. |
| |(user contrib.) | - ? | |
| | | | |
+---------+------------------------+-------------------+------------------------+
|ext |Validation is delegated | | |
| |to an external program. | | |
| | | - Lots of | - Most available |
| | | possibilities. | programs work only |
| | | | under Unix. |
| | | | |
+---------+------------------------+-------------------+------------------------+
|joomla |Users are validated | | |
| |against a Joomla! | | |
| |installation running on | | |
| |the same server | | |
| | | | |
+---------+------------------------+-------------------+------------------------+
|wordpress|Users are validated | | |
| |against a WordPress | | |
| |installation running on | | |
| |the same server | | |
| | | | |
+---------+------------------------+-------------------+------------------------+
External authentication programs
--------------------------------
+------------------+------------------+-----------------+-------------------+
|Program |Description |Pros |Cons |
+------------------+------------------+-----------------+-------------------+
|badpw.pl |Perl script with | | |
| |usernames and | | |
| |passwords hard | - Very simple | - No security at |
| |coded in. | to setup. | all. |
| |Not for use this | | |
| |in a production | | |
| |environment - it's| | |
| |just to | | |
| |demonstrate. | | |
+------------------+------------------+-----------------+-------------------+
|crypt_passwd.pl |Idem, but with | | |
| |passwords | | |
| |encrypted. | | |
+------------------+------------------+-----------------+-------------------+
|smb_auth |Uses Samba SMB API| | |
| |to authenticate | | |
| |users at an NT | - For corporate| - Only works on a|
| |domain controller.| intranets using| Unix server. |
| |smb_auth.c source | NT domain | |
| |provided. | security. | - Requires a Unix|
| | | | server in an |
| | | | organization |
| | | | using Windows |
| | | | security. |
| | | | Vicious! |
| | | | |
+------------------+------------------+-----------------+-------------------+
|nwauth |Connects to a | | |
| |Netware server. | | |
| | | - For corporate| - Only works on a|
| | | intranets using| Unix server. |
| | | Netware servers| |
| | | security. | - Requires a Unix|
| | | | server in an |
| | | | organization |
| | | | using Netware |
| | | | security. |
| | | | Vicious! |
| | | | |
+------------------+------------------+-----------------+-------------------+
|auth_ldap.pl |Uses LDAP | | |
| | | | |
| | | | - The PHP ldap |
| | | | module is |
| | | | recommended |
| | | | instead of this |
| | | | one. |
| | | | |
+------------------+------------------+-----------------+-------------------+
|auth_ldapsearch.pl|Uses LDAP | | |
| | | | |
| | | | - The PHP ldap |
| | | | module is |
| | | | recommended |
| | | | instead of this |
| | | | one. |
| | | | |
+------------------+------------------+-----------------+-------------------+
|auth_pam.pl |Uses PAM | | |
| | | | |
| | | - For Unix | |
| | | system uses PAM| |
| | | (especially | |
| | | Linux, but also| |
| | | SUN Solaris) | |
| | | | |
+------------------+------------------+-----------------+-------------------+
Which session scheme to choose
==============================
The session scheme is the way the user and password is queried and recorded.
This one is a no-brainer. Use the "php" session scheme, unless you are using
'wordpress; authentication, in which case use the 'wordpress' session scheme.
The others are left in for historical reasons:
+---------+------------------------------+--------------------+----------------+
|Type |Description |Pros |Cons |
+---------+------------------------------+--------------------+----------------+
|php |Use PHP's native session | | |
| |handling. Recommended. | | |
| |(Session data is usually saved| - Recommended by | - Any? |
| |in a file on the server) | PHP doctors, PHP | |
| | | moms, etc. | |
| | | | |
+---------+------------------------------+--------------------+----------------+
|http |Use the "HTTP basic | | |
| |authentication" protocol to | | |
| |get a user/password popup. | - Simple. | - Incompatible|
| | | | with IIS web |
| | | - This was the | servers. |
| | | default in MRBS | |
| | | 1.1 for most | - No way to |
| | | authentication | log out. |
| | | schemes. | |
| | | | |
+---------+------------------------------+--------------------+----------------+
|cookie |Save the user/password in | | |
| |cookies on the client's web | | |
| |browser. | - Less demanding | - Some users |
| | | for the server | disable |
| | | than PHP native | cookies on |
| | | sessions. (No | their browser.|
| | | files stored) | |
| | | | |
+---------+------------------------------+--------------------+----------------+
|nt |The users identity is queried | | |
| |AND validated by an NT/IIS | | |
| |server running in | - For corporate | - Incompatible|
| |authenticated access mode. | intranets using | with Linux |
| |(That is anonymous access | NT/2000/XP servers| servers by |
| |disabled, or Access Control | in authenticated | definition. |
| |Lists enabled) | access mode. | |
| | | | - Does not |
| |Use in combination with | | work on the |
| |authentication "none", as the | | Internet. |
| |authentication is already done| | |
| |by IIS during the session | | - Does not |
| |initiation. | | allow |
| | | | anonymous |
| | | | browsing. |
| | | | |
+---------+------------------------------+--------------------+----------------+
|omni |The users identity is queried | | |
| |AND validated by an Omnicron | | |
| |OmniHTTPd web server. | - For users of | - For users of|
| | | Omnicron OmniHTTPd| Omnicron |
| |Use in combination with | web servers. | OmniHTTPd web |
| |authentication "none", as | | servers. |
| |authentication is already done| | |
| |by OmniHTTPd during the | | |
| |session initiation. | | |
+---------+------------------------------+--------------------+----------------+
|remote_ |The user's identity is | | |
|user |determined by reading the | | |
| |REMOTE_USER environment | - For users that | - Requires a |
| |variable. | already have an | web server |
| |Use in combination with | wider auth. | setup that |
| |authentication "none", as | scheme that sets | sets |
| |authentication has already | REMOTE_USER, allows| REMOTE_USER. |
| |been done by the system that | MRBS to use that | Could be hard |
| |sets REMOTE_USER | scheme | to set up |
+---------+------------------------------+--------------------+----------------+
|ip |Users are identified by the IP| | |
| |address of their computer. | | |
| | | - Easy to setup, | - Incompatible|
| |Use in combination with | for MRBS | with DHCP. |
| |authentication "none" or | evaluation. | |
| |"config". | | - Users cannot|
| | | | make changes |
| | | | from a |
| | | | different |
| | | | computer. |
| | | | |
+---------+------------------------------+--------------------+----------------+
|host |Users are identified by the | | |
| |DNS name of their host | | |
| |computer. | - Easy to setup, | - Users cannot|
| | | for MRBS | make changes |
| |Use in combination of | evaluation. | from a |
| |authentication "none" or | | different |
| |"config". | | computer. |
| | | | |
+---------+------------------------------+--------------------+----------------+
|joomla |Use when using Joomla! | | |
| |authentication. | | |
| | | | |
+---------+------------------------------+--------------------+----------------+
|wordpress|Use when using WordPress | | |
| |authentication. | | |
| | | | |
+---------+------------------------------+--------------------+----------------+
How to configure authentication
===============================
Users
-----
You don't configure users in MRBS. Users (and their password) are configured in
an external authentication server.
Exceptions:
- The "config" authentication is managed by MRBS, using a list of names and
passwords in config.inc.php. This is done by specifying: $auth["user"][
"username1"] = "password1"; $auth["user"]["username2"] = "password2";
etc
- The "db" authentication is managed by MRBS, using a list of names and
passwords stored in mrbs database.
Administrators
--------------
Prerequisite: Administrators are also users. They must have a valid user name
and password in the selected authentication server.
Administrators are defined in config.inc.php. This is done by specifying:
$auth["admin"][] = "username1";
$auth["admin"][] = "username2";
etc
You can have as many administrators as you want in this list.
Exceptions:
- In the "db" authentication method, access rights are stored in the MRBS
database and are managed by MRBS.
The default MRBS configuration uses PHP sessions, and a user list in
config.inc.php for authentication. It defines three demo users 'alice' 'bob'
and 'administrator'. The 'administrator' user is also in the administrators
list by default. You will almost surely want to change these.
If IP authentication is used, for "username" use the IP address.
In this case, make sure to define the local host (127.0.0.1) as an
administrator. This allows to conveniently administer the reservation system
locally on the server.
Session type
------------
Choose one type in the list above, and set the $auth["session"] parameter in
config.inc.php. Example:
$auth["session"] = "php";
Authentication type
-------------------
Choose the internal authentication module you want.
Internal PHP modules
--------------------
If it's an internal PHP module, set the $auth["type"] parameter in
confing.inc.php. Example:
$auth["type"] = "pop3";
Then set the type-specific parameters in config.inc.php. See details in the
authentication descriptions below.
External programs
-----------------
If you want to use an external authentication program, set $auth["type"] =
"ext"; and set the additional parameters:
- The name of the selected program in $auth["prog"].
Don't forget to prefix it with "./" under Unix and ensure that the
program is executable by the "user" that the webserver runs as.
Example:
$auth["prog"] = "./smb_auth";
- The arguments to pass to the above program in $auth["params"].
$auth["params"] = "#USERNAME# #PASSWORD#";
At runtime "#USERNAME#" and "#PASSWORD#" will get replaced with the username
and password that the user entered to login. The string can contain other
arguments in addition to the above two.
Internal PHP Authentication Modules Configuration
=================================================
Config Authentication
---------------------
Config Authentication uses no external server. It uses a list of users
config.inc.php. Configure it as follows:
$auth["type"] = "config";
Then add the list of users:
$auth["user"]["username1"] = "password1";
$auth["user"]["username2"] = "password2";
etc
Note: If the password contains the characters \ or $, then it's necessary to
prefix them with a \. For example for password pa$$word, use the string =
"pa\$\$word".
Finally put at least one of the users in the administrator's list.
$auth["admin"][] = "username2";
etc
DB Authentication
-------------------
Authentication method, usable on the Internet.
It works by storing the list of users in a new table called mrbs_users in
the mrbs database.
The authentication is done by the module auth_db.inc.
Enable it by setting $auth["type"]="db" in config.inc.php.
The list of users is displayed by clicking on the "User list" link in
the logon box in the top banner.
This list is managed by module edit_users.php.
Administrators have the right to edit every entry, and add or remove users.
Simple users only have the right to edit their own entry.
The first time it is accessed, the mrbs_users table is automatically
created.
*** WARNING ***
After you have set up MRBS, the first thing you must do is go to the
"User list" and set up a user with administrator rights. Until you
do this the system is open and the first person to go to the "User list" link
will be able to set up an administrator and lock you out of the system. You
will then only be able to get back into the system by droppng the users
table.
Once you have set up the first administrator you can then log on to
the system using the username and password you have just created and
create more users.
*** END OF WARNING ***
Upgrading from pre-1.4.2 systems:
Versions of MRBS before 1.4.2 did not store access rights in the database
and relied on the list of admins in the config file. If you are upgrading
from a pre-1.4.2 system, MRBS will automatically upgrade the users table in the
database by adding a field for access rights level and give admin rights to
those users for whom admin access is defined in the config file. So, if
upgrading, you will need to make sure that your admins are set in the config
file until you have run edit_users.php (by following the "User list" link) for
the first time. Once you have run edit_users.php the admin definitions in the
config file are no longer used and can be deleted if you wish.
It's possible, and very simple, to add new application-specific fields in
the mrbs_users table.
No change is needed in edit_users.php editor code.
Edit_users.php will automatically detect the new fields and add columns for
them.
The new fields can either be added beforehand in the code that creates the
table in the beginning of edit_users.php (See comments there);
Or they can be added afterwards using database admin tools
Note: The first three fields (id, level, name, password) must not be
tampered with. All others are modifiable at will.
Future improvements
- Have a second level of administrators (level 3 users), with only such
level 3 users allowed to edit the user database. This would be similar to
all other authentications in mrbs, which delegate the user accounts
management to an external authority.
External DB (db_ext) Authentication
-----------------------------------
Authentication method, usable on the Internet.
It works by using one of the installer's own databases. The database can
be any database system for which MRBS has a database abstraction. You can
configure how to connect to the database server, what kind of database
system it is (mysql, mysqli, pgsql currently), the database/table to
use and the names of the "user" and "password" columns.
The configuration items are held in config.inc.php and are as follows:
$auth['db_ext']['db_system'] = 'mysql'; /* Or 'mysqli', 'pgsql' */
$auth['db_ext']['db_host'] = 'localhost';
The server to connect to.
$auth['db_ext']['db_username'] = 'authuser';
$auth['db_ext']['db_password'] = 'authpass';
The MySQL username and password to connect with.
$auth['db_ext']['db_name'] = 'authdb';
The name of the database.
$auth['db_ext']['db_table'] = 'users';
The table that holds the authentication data.
$auth['db_ext']['column_name_username'] = 'name';
$auth['db_ext']['column_name_password'] = 'password';
The names of the two columns that hold the authentication data.
$auth['db_ext']['password_format'] = 'md5';
This is the format of the password entries in the table. You can specify
'md5', 'sha1', 'sha256', 'crypt' or 'plaintext'.
$auth['db_ext']['column_name_level'] = 'level';
This configuration item is optional and contains the name of the column
that hold the access level of the user.
POP3 Authentication
-------------------
MRBS has POP3 Authentication support. This method will first try to
authenticate using APOP, and fall back to standard USER/PASS if that
fails. This can be used by setting config.inc.php as follows:
$auth["type"] = "pop3";
Also you will need to change the section:
# 'auth_pop3' configuration settings
# Where is the POP3 server
$pop3_host = "pop3-server-name";
# The POP3 server port
$pop3_port = "110";
You will almost certainly not need to change the POP3 port number.
This method supports authentication against multiple servers using
the syntax below:
Multiple servers all using the same port:
# 'auth_pop3' configuration settings
# Where is the POP3 server
$pop3_host[] = "localhost";
$pop3_host[] = "myisp.co.uk";
# The POP3 server port
$pop3_port = "110";
Multiple servers with the option of different ports for each server:
# 'auth_pop3' configuration settings
# Where is the POP3 server
$pop3_host[] = "localhost";
$pop3_host[] = "myisp.co.uk";
# The POP3 server ports in the same order as the hosts
$pop3_port[] = "110";
$pop3_port[] = "110";
Note: if you use the latter configuration then an equal number of hosts
and ports must be specified or authentication will fail.
IMAP Authentication
--------------------
Very similar in principle to the pop3 authentication.
MRBS has IMAP Authentication support. This can be used by setting
config.inc.php as follows:
$auth["type"] = "imap";
Also you will need to change the section:
# 'auth_imap' configuration settings
# Where is the IMAP server
$imap_host = "imap-server-name";
# The IMAP server port
$imap_port = "143";
You will almost certainly not need to change the IMAP port number.
This method supports authentication against multiple servers using
the syntax below. It will try all the servers until a match is found
or it fails to authenticate the user.
Multiple servers all using the same port:
# 'auth_imap' configuration settings
# Where is the IMAP server
$imap_host[] = "localhost";
$imap_host[] = "myisp.co.uk";
# The IMAP server port
$imap_port = "143";
Multiple servers with the option of different ports for each server:
# 'auth_imap' configuration settings
# Where is the IMAP server
$imap_host[] = "localhost";
$imap_host[] = "myisp.co.uk";
# The IMAP server ports in the same order as the hosts
$imap_port[] = "143";
$imap_port[] = "143";
Note: if you use the latter configuration then an equal number of hosts
and ports must be specified or authentication will fail.
LDAP Authentication
-------------------
There are currently three methods for doing LDAP authentication, auth_ldap,
auth_ldap.pl, auth_ldapsearch.pl. The preferred method, auth_ldap, uses
PHP's LDAP extension which must be compiled into PHP or installed and loaded
as a plugin extension in your php.ini. This method is described here.
The other methods use the 'ext' authentication method and are described
further on in this file.
This method can be used by setting config.inc.php as follows:
$auth["type"] = "ldap";
Also you will need to change the section:
# 'auth_ldap' configuration settings
# Where is the LDAP server
$ldap_host = "localhost";
# If you have a non-standard LDAP port, you can define it here
#$ldap_port = 389;
# If you want to use LDAP v3, change the following to true
$ldap_v3 = false;
# If you want to use TLS, change following to true
$ldap_tls = false;
# LDAP base distinguish name
# See AUTHENTICATION for details of how check against multiple base dn's
$ldap_base_dn = "ou=organizationalunit,dc=my-domain,dc=com";
# Attribute within the base dn that contains the username
$ldap_user_attrib = "uid";
You only need to set $ldap_port if your LDAP server uses a non-standard
port.
If you want to use LDAP v3, or TLS over LDAP set $ldap_v3 or $ldap_tls
to true, respectively.
This method will attempt an authenticated bind to the ldap server using
the supplied password and a distinguished name, which is formed from the
base distinguished name, the user attribute and the user name.
This method supports multiple values for most of the configuration
parameters, including $ldap_base_dn entries and $ldap_user_attrib
values. The authentication is attempted with each set of configuration
parameters in turn until it succeeds or it fails to authenticate the user.
Multiple base distinguished names with the same user attribute for each
base dn:
# 'auth_ldap' configuration settings
# Where is the LDAP server
$ldap_host = "localhost";
# LDAP base distinguish names
$ldap_base_dn[] = "ou=People, o=myCompany, c=US";
$ldap_base_dn[] = "ou=Administrators, o=myCompany, c=US";
#
$ldap_user_attrib = "uid";
Multiple base distinguished names with the option of different user attributes
for each base dn:
# 'auth_ldap' configuration settings
# Where is the LDAP server
$ldap_host = "localhost";
# LDAP base distinguish names
$ldap_base_dn[] = "ou=People, o=myCompany, c=US";
$ldap_base_dn[] = "ou=Administrators, o=myCompany, c=US";
#
$ldap_user_attrib[] = "uid";
$ldap_user_attrib[] = "cn";
Note: if you use the latter configuration then an equal number of base dn's
and user attributes must be specified or authentication will fail.
NIS Authentication
------------------
$auth["type"] = "nis";
Authenticates the user from the NIS passwd.byname map. Requires the crypt
password to be stored in the passwd.byname map and won't therefore work
with shadow password NIS.
NT Authentication
-----------------
MRBS has Microsoft Windows NT/IIS authentication support. This can be used by
setting config.inc.php as follows:
$auth["session"] = "nt";
$auth["type"] = "none";
Note that technically NT authentication is actually an MRBS session scheme. We
put it in this list as it is related with authentication anyway.
To add an admin, just add his user's Windows user account like this:
$auth["admin"][] = "nt_username";
Also this scheme is fairly simple (it relies on IIS determining a user's
Windows user account identity, before allowing the user to establish a network
connection with the server) there are some requirements for it to work (these
notes are based on IIS 5.0):
- You have to configure you mrbs directory (at least) to use either
'Basic Authentication' or 'Integrated Windows Authentication' (formerly
called NTLM or Windows NT Challenge/Response authentication).
To enable a WWW authentication method in IIS:
In the Internet Information Services snap-in, select your site, but preferably
only mrbs directory, and open its property sheets. Select the Directory
Security property sheet. Under Anonymous Access and Authentication Control,
click Edit. In the Authentication Methods dialog box, select one or more
appropriate methods.
The simplest way is to use 'Integrated Windows Authentication' because unlike
'Basic authentication', it does not prompt users for a user name and password.
The current Windows user information on the client computer is used for the
'integrated Windows authentication'. It is also a more secure form of
authentication because the user name and password are not sent across the
network.
But if you really want your users to enter their domain username/password, you
have to select 'Basic Authentication'. The advantage of Basic authentication is
that it is part of the HTTP specification, and is supported by most browsers.
So, theoretically, you can log in with a valid domain username/password with a
non-Microsoft browser, but frankly I did not tested it. The disadvantage is
that 'Basic authentication' transmit passwords in an unencrypted form.
- To use 'Integrated Windows Authentication', you HAVE TO use the
Microsoft browser too. Currently, only Internet Explorer, version 2.0 and
later, supports this.
- The 'Anonymous access' must be disabled.
- If you enable both Basic and Integrated authentication, Integrated
authentication takes precedence over Basic authentication.
- 'Integrated Windows authentication' does not work over HTTP Proxy
connections or other firewall applications. So this scheme is more suitable
for an Intranet, but 'Basic Authentication' should work (not tested).
All this was tested against IIS 5.0 on Windows 2000 server and Windows 2000
workstations using Internet Explorer 6.0, but this should work from IIS 4.0.
OMNI Authentication
--------------------
OMNI Authentication using Omnicron OmniHTTPd web server security features.
Very similar in principle to NT authentication.
$auth["session"] = "omni";
$auth["type"] = "none";
Note that technically Omni authentication is actually an MRBS session scheme.
We put it in this list as it is related with authentication anyway.
REMOTE_USER Authentication
--------------------------
Get user identity/password using the REMOTE_USER environment variable
To use this session scheme, set in config.inc.php:
$auth['session'] = 'remote_user';
$auth['type'] = 'none';
If you want to display a logout link, set in config.inc.php:
$auth['remote_user']['logout_link'] = '/logout/link.html'
Joomla! Authentication
----------------------
Set in config.inc.php
$auth['joomla']['rel_path'] = '..'; // Path to the Joomla! installation relative to MRBS.
// [Note that although in Joomla! access levels are solely used for what users are allowed to *see*, we use
// them in MRBS to determine what they can see and do, ie we map them onto MRBS user levels. While this
// does not strictly follow the Joomla! access control model, it does make it much simpler to give users
// MRBS permissions.]
// List of Joomla! viewing access level ids that have MRBS Admin capabilities. You can if you wish use
// the existing viewing access levels. However we recommend creating a new access level, eg
// "MRBS Administrator" and assigning that to user groups, as it will then be clearer which groups
// have what kind of access to MRBS.
$auth['joomla']['admin_access_levels'] = array(); // Can either be a single integer, or an array of integers.
// As above, but for ordinary user rights. Create for example a viewing access level called "MRBS User"
// and assign that level to user groups as appropriate.
$auth['joomla']['user_access_levels'] = array(); // Can either be a single integer, or an array of integers.
WordPress Authentication
------------------------
Set in config.inc.php
$auth['session'] = 'wordpress';
$auth['type'] = 'wordpress';
$auth['wordpress']['rel_path'] = '..'; // Path to the WordPress installation relative to MRBS.
// List of WordPress roles that have MRBS Admin capabilities. The default is 'administrator'.
// Note that these role names are the keys used to store the name, which are typically in lower case
// English, eg 'administrator', and not the values which are displayed on the dashboard form, which will
// generally start with a capital and be translated, eg 'Administrator' or 'Administrateur' (French),
// depending on the site language you have chosen for WordPress.
// You can define more than one WordPress role that maps to the MRBS Admin role by using
// an array. The comment below assumes that you have created a new WordPress role (probably by using
// a WordPress plugin) called "MRBS Admin", which will typically (depending on the plugin) have a key of
// 'mrbs_admin', and that you assigned that role to those users that you want to be MRBS admins.
$auth['wordpress']['admin_roles'] = 'administrator'; // can also be an array, eg = array('administrator', 'mrbs_admin');
// List of WordPress roles that have MRBS User capabilities. This allows you to have some WordPress users
// who are authorised to use MRBS and some who are not.
$auth['wordpress']['user_roles'] = array('subscriber', 'contributor', 'author', 'editor', 'administrator');
Then in your WordPress wp-config.php file set:
// Define cookie paths so that login cookies can be shared with MRBS
$domain_name = 'example.com'; // Set to your domain name
define('COOKIEPATH', '/');
define('SITECOOKIEPATH', '/');
// In the definition below the '.' is necessary for older browsers (see
// http://php.net/manual/en/function.setcookie.php).
define('COOKIE_DOMAIN', ".$domain_name");
define('COOKIEHASH', md5($domain_name));
External Authentication Programs Configuration
==============================================
Perl password list
------------------
"badpw.pl" is a short piece of Perl, which can quickly be used to demonstrate
how the "ext" authentication provider works.
It has usernames and passwords hard coded. I don't expect anyone to use this in
a production environment - it's just to demonstrate.
In the config.inc.php file authentication section, set:
# Authentication settings - read AUTHENTICATION
$auth["type"] = "ext";
$auth["prog"] = "./badpw.pl";
$auth["params"] = "#USERNAME# #PASSWORD#";
NOTE: The last line are parameters that will get passed to the 'badpw.pl'
script. At runtime "#USERNAME#" and "#PASSWORD" will get replaced with the
username and password that the user entered to login.
NOTE: Under Unix, make sure badpw.pl has execution rights: 'chmod +x badpw.pl'
Once you have changed this then look at the /mrbs/ page through your browser.
When you click one of the (+) buttons, you will be asked for a username and
password. Check badpw.pl for the valid combinations.
To try out an "admin" user, add an appropriate username to the section that
says:
$auth["admin"][] = "....";
Crypted password authentication
-------------------------------
crypt_passwd.pl is like the badpw.pl method above but uses a file containing
usernames and their crypted passwords
config.inc.php should be changed to have a section that reads something like:
$auth["type"] = "ext";
$auth["prog"] = "../crypt_passwd.pl";
$auth["params"] = "/etc/httpd/mrbs_passwd #USERNAME# #PASSWORD#";
As you can see the crypt_passwd.pl script takes 3 parameters.
The first parameter is the filename of the password file.
It must be readable by the user which PHP is running as, which is usually the
user the web server is running as. The password file must consist of pairs of
username and crypted password, seperated by a colon. See crypt_passwd.example
for an example password file.
NOTE: Under Unix, make sure crypt_passwd.pl has execution rights: 'chmod +x
crypt_passwd.pl'
SMB Authentication
------------------
Here are instructions gathered from several users for using SMB authentication:
Included is the source (smb_auth.c). This is a very simple program, that
returns "true" if the username/password are valid and "false" otherwise.
FOLLOW THESE STEPS TO INSTALL
- Download the PAM library from
http://www.mirror.ac.uk/sites/ftp.samba.org/pam_smb/ (current one is 1.1.7)
or type:
$ wget http://www.mirror.ac.uk/sites/ftp.samba.org/pam_smb/pam_smb-1.1.7.tar.gz
- $ tar -xvzf pam_smb-1.1.7.tar.gz
or gtar -xvzf pam_smb-1.1.7.tar.gz
- $ cd pam_smb
- $ ./configure
[or if you want to disable encrypted passwords you can run
$ ./configure --disable-encrypt-pass
]
- $ make
[ or maybe on Solaris
$ gmake ]