-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConfiguration.html
More file actions
1012 lines (998 loc) · 43.7 KB
/
Configuration.html
File metadata and controls
1012 lines (998 loc) · 43.7 KB
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>CGIpaf configuration</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#0000ff" alink="#ff0000" vlink="#2f009f">
<h1>CGIpaf 1.3.5 Configuration</h1>
<hr>
<a name="copyright"></a>
<h2>Copyright Notice</h2>
<a name="copyright_documentation"></a>
<h3>Copyright documentation</h2>
<p>
The documentation for CGIpaf is licensed under the terms of the FreeBSD
Documentation License.
<h4>The FreeBSD Documentation License</h4>
<p>
Copyright © 2001 - 2020 Staf Wagemakers
<p>
Redistribution and use in source (plaintext, HTML) and 'compiled' forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without modification, are permitted provided that the following conditions are met:
<ol>
<li>
Redistributions of source code (plaintext, HTML) must retain the above copyright notice, this list of conditions and the following disclaimer.
</li>
<li>
Redistributions in compiled form (transformed to other DTDs, converted to PDF, PostScript, RTF and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
</li>
</ol>
<p>
THIS DOCUMENTATION IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
</p>
<a name="copyright_software"></a>
<h3>Copyright Software</h2>
CGIpaf (the software) is licensed under the terms of the GNU General Public
License version 2 or later.
<p>
Copyright © 2001 - 2020 Staf Wagemnakers
<p>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
<p>
This program 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. See the
GNU General Public License for more details.
<p>
You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
<hr>
<h1>Content</h1>
<ul>
<li><a href="#syntax">Syntax</a></li>
<li><a href="#sections">Sections</a></li>
<li><a href="#directives">Directives</a>
<ul>
<li><a href="#syslog">syslog</a></li>
<li><a href="#loglevel">loglevel</a></li>
<li><a href="#pam_service">pam_service</a></li>
<li><a href="#document_root">document_root</a></li>
<li><a href="#login_document">login_document</a></li>
<li><a href="#error_loginname">error_loginname</a></li>
<li><a href="#error_access">error_access</a></li>
<li><a href="#error_invalid">error_invalid</a></li>
<li><a href="#error_newpassword">error_newpassword</a></li>
<li><a href="#error_match">error_match</a></li>
<li><a href="#error_unchanged">error_unchanged</a></li>
<li><a href="#error_tooshort">error_tooshort</a></li>
<li><a href="#error_torlong">error_toolong</a></li>
<li><a href="#error_locked">error_locked</a></li>
<li><a href="#error_forwardto">error_forwardto</a></li>
<li><a href="#error_invalidforwardto">error_invalidforwardto</a></li>
<li><a href="#msg_success">msg_success</a></li>
<li><a href="#msg_changed">msg_changed</a></li>
<li><a href="#msgmsg_updated">msg_updated</a></li>
<li><a href="#error_read">error_readname</a></li>
<li><a href="#error_readforward">error_readforward</a></li>
<li><a href="#error_readkeepmsg">error_readkeepmsg</a></li>
<li><a href="#error_readautoreply">error_readautoreply</a></li>
<li><a href="#error_autoreply_msg">error_autoreply_msg</a></li>
<li><a href="#error_cookie">error_cookie</a></li>
<li><a href="#error_cookietimeout">error_cookietimeout</a></li>
<li><a href="#error_accessdb">error_accessdb</a></li>
<li><a href="#error_cracklib">error_cracklib</a></li>
<li><a href="#error_mailcfgscript">error_mailcfgscript</a></li>
<li><a href="#error_viewmailcfgscript">error_viewmailcfgscript</a></li>
<li><a href="#error_pam">error_pam</a></li>
<li><a href="#error_illegalword">error_illegalword</a></li>
<li><a href="#min_uid">min_uid</a></li>
<li><a href="#max_uid">max_uid</a></li>
<li><a href="#min_length">min_length</a></li>
<li><a href="#max_length">max_length</a></li>
<li><a href="#accessdb">accessdb</a></li>
<li><a href="#cracklib">cracklib</a></li>
<li><a href="#cracklib_dictpath">cracklib_dictpath</a></li>
<li><a href="#vmail_support">vmail_support</a></li>
<li><a href="#passwd_location">passwd_location</a></li>
<li><a href="#shadow_location">shadow_location</a></li>
<li><a href="#illegal_words">illegal_words</a></li>
<li><a href="#set_pam_change_expired_authtok">set_PAM_CHANGE_EXPIRED_AUTHTOK</a>
<strong><font color="red">This directive is absolute, and will be removed...</font></strong></li>
<li><a href="#max_invalid">max_invalid</a></li>
<li><a href="#invalid_timeout">invalid_timeout</a></li>
<li><a href="#sendmail">sendmail</a></li>
<li><a href="#formail">formail</a></li>
<li><a href="#domain">domain</a></li>
<li><a href="#use_statefile">use_statefile</a></li>
<li><a href="#run_success">run_success</a></li>
<li><a href="#run_locked">run_locked</a></li>
<li><a href="#run_before_mailcfg">run_before_mailcfg</a></li>
<li><a href="#run_after_mailcfg">run_after_mailcfg</a></li>
<li><a href="#run_mailcfg">run_mailcfg</a></li>
<li><a href="#mailcfg_check">mailcfg_check</a></li>
<li><a href="#run_viewmailcfg">run_viewmailcfg</a></li>
<li><a href="#set_script_filename">set_script_filename</a></li>
<li><a href="#unset_script_filename">unset_script_filename</a></li>
<li><a href="#cookie_timeout">cookie_timeout</a></li>
<li><a href="#mailcfg_document">mailcfg_document</a></li>
<li><a href="#error_deldotforward">error_deldotforward</a></li>
<li><a href="#error_deldotprocmailrc">error_deldotprocmailrc</a></li>
<li><a href="#error_openvacations">error_openvacations</a></li>
<li><a href="#error_updateprocmailrc">error_updateprocmailrc</a></li>
<li><a href="#aclorder">AclOrder</a></li>
<li><a href="#allowusers">AllowUsers</a></li>
<li><a href="#denyusers">DenyUsers</a></li>
<li><a href="#allowgroups">AllowGroups</a></li>
<li><a href="#denygroups">DenyGroups</a></li>
</ul>
</li>
<li><a href="#variables">Variables</a></li>
<li><a href="#redirect">Redirect</a></li>
<li><a href="#htmlfile">HTML files</a></li>
<li><a href="#command">Scripts</a>
<ul>
<li><a href="#command_overview">Overview</a></li>
<li><a href="#command_syntax">Syntax</a></li>
<li><a href="#command_examples">Examples</a></li>
</ul>
</li>
<li><a href="#acl">Access Control List</a>
<ul><li><a href="#aclexamples">Examples</a></li></ul></li>
</ul>
<h1><a name="syntax">Syntax</a></h1>
<p>
The configuration file (cgipaf.conf) contains one directive per line.
The directive names are case insensitive, the values are case sensitive.
Everything after a hash ( # ) is ignored. Empty lines and whitespaces are
also ignored.
If a directive appears more than ones the last one is used.
Sections are grouped between <section_name> ...
</section_name>, the
section names are like the directive names case insensitive.
</p>
<h1><a name="sections">Sections</a></h1>
<p>
The configuration file has three sections "global", "passwd" and "mailcfg".
The directives that don't belong to a section are global. Global directives
apply to all sections unless they're overwritten in the sections.<BR>
The "passwd" section is used by passwd.cgi, viewmailcfg.cgi and mailcfg.cgi
use the "mailcfg" section.
</p>
<h1><a name="directives">Directives</a></h1>
<p>
The following parameters control cgipaf features and configuration. If a
option is not specified or invalid the default built-in messages are used.
</p>
<h2><a name="syslog">syslog</a></h2>
<p><strong>Syntax:</strong> syslog <em>on|off</em><br>
<strong>Default:</strong> on<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><br>
</p>
<p>enable syslog messages</p>
<p>all the authentication events are logged with LOG_AUTHPRIV facility, other events are logged with the LOG_USER facility</p>
<h2><a name="loglevel">loglevel</a></h2>
<p><strong>Syntax:</strong> loglevel <em>number</em><br>
<strong>Default:</strong> 6<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><br>
</p>
<p>set the syslog level, messages of a higher significance will be reported as well.<BR>
e.g. if loglevel is set to 1 (LOG_ALERT) messages with loglevel 0 (LOG_EMERG) are also reported.
</p>
<table>
<tr><td><b>0</b></td><td>LOG_EMERG</td><td> system is unusable</td></tr>
<tr><td><b>1</b></td><td>LOG_ALERT</td><td> action must be taken immediately</td></tr>
<tr><td><b>2</b></td><td>LOG_CRIT</td><td> critical conditions</td></tr>
<tr><td><b>3</b></td><td>LOG_ERR</td><td> error conditions</td></tr>
<tr><td><b>4</b></td><td>LOG_WARNING</td><td> warning conditions</td></tr>
<tr><td><b>5</b></td><td>LOG_NOTICE</td><td> normal, but significant, condition</td></tr>
<tr><td><b>6</b></td><td>LOG_INFO</td><td> informational message</td></tr>
<tr><td><b>7</b></td><td>LOG_DEBUG</td><td> debug-level message</td></tr>
</table>
<h2><a name="pam_service">pam_service</a></h2>
<p><strong>Syntax:</strong> pam_service <em>pam service name</em><br>
<strong>Default:</strong> passwd<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><br>
<p>
Set the pam service name, if not set "passwd" is used. The passwd pam service
( /etc/pam.d/passwd ) usually doesn't have an entry for user authentication,
therefor /etc/pam.d/other has to have a line auth set to pam_unix.so.
</p>
<pre><code><tt>
auth required pam_unix.so
account required pam_unix.so
</tt></code></pre>
<p>If you don't like this for security reason etc, you can set the pam_service directive to "cgipaf" and create the file /etc/pam.d/cgipaf that looks like this</p>
<pre><code><tt>
auth required pam_unix.so
account required pam_unix.so
password required pam_unix.so md5
</tt></code></pre>
<h2><a name="document_root">document_root</a></h2>
<p><strong>Syntax:</strong> document_root <em>path</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><br>
</p>
<p>location of the custom html message files</p>
<h2><a name="login_document">login_document</a></h2>
<p><strong>Syntax:</strong> login_document <em>filename</em> <b>OR</b>
login_document Redirect <em>location</em><br>
<strong>Default:</strong> "error reading data please contact the
webmaster\n"<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
if the program is executed without parameters this message is displayed
</p>
<h2><a name="error_loginname">error_loginname</a></h2>
<strong>Syntax:</strong> error_loginname <em>filename</em> <b>OR</b>
error_loginname Redirect <em>location</em><br>
<strong>Default:</strong> "Can't read loginname\n"<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
The user forgot to type his loginname.
</p>
<h2><a name="error_access">error_access</a></h2>
<strong>Syntax:</strong> error_access <em>filename</em> <b>OR</b>
error_access Redirect <em>location</em><BR>
<strong>Default:</strong>"Access denied...\n"<BR>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
The user try to logon as root or the user's uid isn't between
<a href="#min_uid">min_uid</a> & <a href="#max_uid">max_uid</a>.
</p>
<h2><a name="error_invalid">error_invalid</a></h2>
<strong>Syntax:</strong> error_invalid <em>filename</em> <b>OR</b>
error_invalid Redirect <em>location</em><BR>
<strong>Default:</strong> "Invalid password or username.\n"<BR>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
The password is incorrect or the user doesn't exists
</p>
<h2><a name="error_newpassword">error_newpassword</a></h2>
<strong>Syntax:</strong> error_newpasswd <em>filename</em> <b>OR</b>
error_newpassord Redirect <em>location</em><br>
<strong>Default:</strong> "Can't read new password\n"<BR>
<strong>Context:</strong> <passwd>
<p>
can't read new password
</p>
<h2><a name="error_match">error_match</a></h2>
<strong>Syntax:</strong> error_match <em>filename</em> <b>OR</b>
error_match Redirect <em>location</em><BR>
<strong>Default:</strong> "They don't match\n"<BR>
<strong>Context:</strong> <passwd>
<p>
The new passwords doesn't match
</p>
<h2><a name="error_unchanged">error_unchanged</a></h2>
<strong>Syntax:</strong> error_unchanged <em>filename</em> <b>OR</b>
error_unchanged Redirect <em>location</em><BR>
<strong>Default:</strong> "Password Unchanged\n"<BR>
<strong>Context:</strong> <passwd>
<p>
Password Unchanged
</p>
<h2><a name="error_tooshort">error_tooshort</a></h2>
<strong>Syntax:</strong> error_tooshort <em>filename</em> <b>OR</b>
error_tooshort Redirect <em>location</em><BR>
<strong>Default:</strong> "Password too short...\n"<BR>
<strong>Context:</strong> <passwd>
<p>
the password length is below <a href="#min_length">min_length</a>
</p>
<h2><a name="error_torlong">error_toolong</a></h2>
<strong>Syntax:</strong> error_toolong <em>filename</em> <b>OR</b>
error_toolong Redirect <em>location</em><br>
<strong>Default:</strong> "Password too long...\n"<BR>
<strong>Context:</strong> <passwd><BR>
<p>
the password length is above <a href="#max_length">max_length</a>
</p>
<h2><a name="error_locked">error_locked</a></h2>
<strong>Syntax:</strong> error_locked <em>filename</em> <b>OR</b>
error_locked Redirect <em>location</em><BR>
<strong>Default:</strong> "Maximum number of tries exceeded...\n"<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
The user has exceeded the <a href="#max_invalid">max_invalid</a>
tries
</p>
<h2><a name="error_forwardto">error_forwardto</a></h2>
<strong>Syntax:</strong> error_forwardto <em>filename</em> <b>OR</b>
error_forwardto Redirect <em>location</em><br>
<strong>Default:</strong>"Forward to who???"<br>
<strong>Context:</strong> <mailcfg>
<p>
The user has enabled mail forwarding, but didn't supply a forward to mail
address
</p>
<h2><a name="error_invalidforwardto">error_invalidforwardto</a></h2>
<strong>Syntax:</strong> error_invalidforwardto <em>filename</em>
<b>OR</b> error_invalidforwardto <em> Redirect location</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <mailcfg><br>
<p>
The forward to email address is invalid
</p>
<h2><a name="msg_success">msg_success</a></h2>
<strong>Syntax:</strong> msg_success <em>filename</em> <b>OR</b>
msg_success Redirect <em>location</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <passwd>, <mailcfg><BR>
<p>
The password or mail configuration is updated successfully
</p>
<h2><a name="msg_changed">msg_changed</a></h2>
<strong>Syntax:</strong> msg_changed <em>filename</em> <b>OR</b>
msg_changed Redirect <em>location</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
see <a href="#msg_success">msg_success</a>
</p>
<h2><a name="msgmsg_updated">msg_updated</a></h2>
<strong>Syntax:</strong> msg_updated <em>filename</em> <b>OR</b>
msg_updated Redirect <em>location</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
see <a href="#msg_success">msg_success</a>
</p>
<h2><a name="error_read">error_readname</a></h2>
<strong>Syntax:</strong> error_readname <em>filename</em> <b>OR</b>
error_readname Redirect <em>location</em><br>
<strong>Default:</strong> "[CGIpaf] Can't read loginname\n"<br>
<strong>Context:</strong> <mailcfg>
<p>
mailcfg.cgi is unable to read to username, this is probably an error in
<a href="#mailcfg_document">mailcfg_document</a>.
</p>
<h2><a name="error_readforward">error_readforward</a></h2>
<strong>Syntax:</strong> error_readforward <em>filename</em> <b>OR</b>
error_readforward Redirect <em>location</em><br>
<strong>Default:</strong> "[CGIpaf] Can't read forward\n"<br>
<strong>Context:</strong> <mailcfg>
<p>
mailcfg.cgi is unable to read forward, this is probably an error in
<a href="#mailcfg_document">mailcfg_document</a>.
</p>
<h2><a name="error_readkeepmsg">error_readkeepmsg</a></h2>
<strong>Syntax:</strong> error_readkeepmsg <em>filename</em> <b>OR</b>
error_readkeepmsg Redirect <em>location</em><br>
<strong>Default:</strong> "[CGIpaf] Can't read keepmsg\n"<br>
<strong>Context:</strong> <mailcfg>
<p>
mailcfg.cgi is unable to read keep_msg, this is probably an error in
<a href="#mailcfg_document">mailcfg_document</a>.
</p>
<h2><a name="error_readautoreply">error_readautoreply</a></h2>
<strong>Syntax:</strong> error_readautoreply <em>filename</em>
<b>OR</b>error_readautoreply Redirect <em>location</em><br>
<strong>Default:</strong> "[CGIpaf] Can't read autoreply\n"<br>
<strong>Context:</strong> <mailcfg>
<p>
mailcfg.cgi is unable to read autoreply, this is probably an error in
<a href="mailcfg_document">mailcfg_document</a>.
</p>
<h2><a name="error_autoreply_msg">error_autoreply_msg</a></h2>
<strong>Syntax:</strong> error_autoreplymsg <em>filename</em> <b>OR</b>
error_autoreplymsg Redirect <em>location</em><br>
<strong>Default:</strong> "Can't read autoreply_msg...\n"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
The user has enabled autoreply, but didn't supply a autoreply message.
</p>
<h2><a name="error_cookie">error_cookie</a></h2>
<strong>Syntax:</strong> error_cookie <em>filename</em> <b>OR</B>
error_cookie Redirect <em>location</em><br>
<strong>Default:</strong> "To update your mail configuration your browser need to
support cookies...\n"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
mailcfg.cgi can't update the mail configuration without cookies.
</p>
<h2><a name="error_cookietimeout">error_cookietimeout</a></h2>
<strong>Syntax:</strong> error_cookietimeout <em>filename</em>
<b>OR</B> error_cookietimeout Redirect <em>location</em><br>
<strong>Default:</strong> "Cookie timeout exceeded...\n"<br>
<strong>Context:</strong> <mailcfg>
<p>
mailcfg.cgi can't update the mail configuration because the cookie is too
old.
</p>
<h2><a name="error_accessdb">error_accessdb</a></h2>
<strong>Syntax:</strong> error_accessdb <em>filename</em> <b>OR</b>
error_accessdb Redirect <em>location</em><br>
<strong>Default:</strong> "[CGIpaf] configuration error, (view)mailcfg needs a
accessdb.\n Please contact the webmaster"<br>
<strong>Context:</strong> <mailcfg>
<p>
(view)mailcfg.cgi can't work without an
<a href="#accessdb">accessdb</a>
</p>
<h2><a name="error_cracklib">error_cracklib</a></h2>
<strong>Syntax:</strong> error_cracklib <em>filename</em> <b>OR</b>
error_cracklib Redirect <em>location</em><br>
<strong>Default:</strong> "BAD PASSWORD, %{cracklib_error}<br>
<strong>Context:</strong> <passwd>
<p>
cracklib error
</p>
<h2><a name="error_mailcfgscript">error_mailcfgscript</a></h2>
<strong>Syntax:</strong> error_mailcfgscript <em>filename</em> <b>OR</b>
error_mailcfgscript Redirect <em>location</em><br>
<strong>Default:</strong> "run_mailcfg returns a non-null value, %{mailcfg_exitcode}<br>
<strong>Context:</strong> <mailcfg>
<p>
<a href="#run_mailcfg">run_mailcfg</a> failed.
</p>
<h2><a name="error_viewmailcfgscript">error_viewmailcfgscript</a></h2>
<strong>Syntax:</strong> error_viewmailcfgscript <em>filename</em> <b>OR</b>
error_viewmailcfgscript Redirect <em>location</em><br>
<strong>Default:</strong> "run_viewmailcfg returns a non-null value, %{mailcfg_exitcode}<br>
<strong>Context:</strong> <mailcfg>
<p>
<a href="#run_viewmailcfg">run_viewmailcfg</a> failed.
</p>
<h2><a name="error_pam">error_pam</a></h2>
<strong>Syntax:</strong> error_pam <em>filename</em> <b>OR</b>
error_pam Redirect <em>location</em><br>
<strong>Default:</strong> "Can't update password, errno, %{pam_error}<br>
<strong>Context:</strong> <passwd>
<p>
pam error
</p>
<h2><a name="error_illegalword">error_illegalword</a></h2>
<strong>Syntax:</strong> error_illegalword <em>filename</em> <b>OR</b>
error_illegalword Redirect <em>location</em><br>
<strong>Default:</strong> bad password
<strong>Context:</strong> <passwd>
<p>
The new password contains an illegal word.
</p>
<h2><a name="min_uid">min_uid</a></h2>
<strong>Syntax:</strong> min_uid <em>uid</em><br>
<strong>Default:</strong> 100<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><br>
<p>
minimum user id, if a uid is bellow min_uid access will be denied. You
can't set min_uid lower then 10.
</p>
<h2><a name="max_uid">max_uid</a></h2>
<strong>Syntax:</strong> max_uid <em>uid</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> Global, <passwd>, <mailcfg>
<p>
maximum user id, if the uid is higher than max_uid access will be denied.
If max_uid isn't set there is no maximum.
</p>
<h2><a name="min_length">min_length</a></h2>
<strong>Syntax:</strong> min_length <em>length</em><BR>
<strong>Default:</strong> 6<br>
<strong>Context:</strong> <passwd><br>
<p>
minimum password length
</p>
<h2><a name="max_length">max_length</a></h2>
<strong>Syntax:</strong> max_length <em>length</em><br>
<strong>Default:</strong> 8<br>
<strong>Context:</strong> <passwd>
<p>
maximum password length
</p>
<h2><a name="accessdb">accessdb</a></h2>
<strong>Syntax:</strong> accessdb <em>path</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> global, <passwd>, <mailcfg>
<p>
accessdb path, if not set no access database is used. If not set Users
can try to change their password as many times they like.
(view)mailcfg.cgi don't work without an accessdb.
</p>
<h2><a name="cracklib">cracklib</a></h2>
<strong>Syntax:</strong> cracklib <em>on|off</em><br>
<strong>Default:</strong> off<br>
<strong>Context:</strong> <passwd>
<p>
enable cracklib test, the new password is tested with cracklib.
if the password is invalid <a href="#error_cracklib">error_cracklib</a>
is displayed.
</p>
<p>
you have to set the <a href="#cracklib_dictpath">cracklib_dictpath</a>
directive to your cracklib dictpath otherwise cracklib is disabled.
</p>
<p>
CGIpaf support cracklib password testing in the PAM configuration, if cracklib is enabled in
your PAM configuration and you should set cracklib to off.
</p>
<h2><a name="cracklib_dictpath">cracklib_dictpath</a></h2>
<strong>Syntax:</strong> cracklib_dictpath <em>/path/to/cracklib_dict</em><br>
<strong>Default:</strong> off<br>
<strong>Context:</strong> <passwd>
<p>
Set the cracklib_dictpath, the cracklib_dictpath should be set to the
dictionary filename without the extension ( .pwi ), not the directory path.
</p>
<h2><a name="vmail_support">vmail_support</a></h2>
<strong>Syntax:</strong> vmail_support <em>yes|no</em><br>
<strong>Default:</strong> off<br>
<strong>Context:</strong> global, <passwd>, <mailcfg>
<p>
Enable support for Linuxconf virtual email domains passwords<br>
This directive is only available if you've compiled CGIpaf without
PAM support and isn't supported on *BSD systems.
</p>
<h2><a name="passwd_location">passwd_location</a></h2>
<strong>Syntax:</strong> passwd_location <em>/path/to/your/passwd_file</em><br>
<strong>Default:</strong> system passwd<br>
<strong>Context:</strong> global, <passwd>, <mailcfg>
<p>
Set the password file location. This directive is only available if you've
compiled CGIpaf without PAM support and isn't supported on *BSD systems.
</p>
<h2><a name="shadow_location">shadow_location</a></h2>
<strong>Syntax:</strong> passwd_location <em>/path/to/your/shadow_file</em><br>
<strong>Default:</strong> system shadow<br>
<strong>Context:</strong> global, <passwd>, <mailcfg>
<p>
Set the shadow file location. This directive is only available if you've
compiled CGIpaf without PAM support and isn't supported on *BSD systems.
</p>
<h2><a name="illegal_words">illegal_words</a></h2>
<strong>Syntax:</strong> illegal_words <em>word1 word2</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <passwd>
<p>
Specify a list of words that are illegal to use as a part of a new password
</p>
<h2><a name="set_pam_change_expired_authtok">set_PAM_CHANGE_EXPIRED_AUTHTOK</a></h2>
<strong>Syntax:</strong> set_PAM_CHANGE_EXPIRED_AUTHTOK <em>on</em>|<em>off</em><br>
<strong>Default:</strong> on<br>
<strong>Context:</strong> <passwd>
<p>
Set the PAM_CHANGE_EXPIRED_AUTHTOK flag.<br>
<strong><font color="red">This directive is obsolete and will be removed in the next Releases of CGIpaf</font></strong>
</p>
<h2><a name="max_invalid">max_invalid</a></h2>
<strong>Syntax:</strong> max_invalid <em>tries</em><br>
<strong>Default:</strong> 3<br>
<strong>Context:</strong> global, <passwd>, <mailcfg>
<p>
maximum invalid tries, if not set the default value (3) will be used.
</p>
<h2><a name="invalid_timeout">invalid_timeout</a></h2>
<strong>Syntax:</strong> invalid_timeout <em>seconds</em>
<strong>Default:</strong> 600<br>
<strong>Context:</strong> global, <passwd>, <mailcfg><Br>
<p>
time in seconds that a user will be locked out if the max_invalid tries
has been exceeded.
</p>
<h2><a name="sendmail">sendmail</a></h2>
<strong>Syntax:</strong> sendmail <em>path_to_sendmail</em><br>
<strong>Default:</strong> "/usr/lib/sendmail"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
mailcfg.cgi uses the path_to_sendmail in ~/.procmailrc, if your mailer is
on another location than "/usr/lib/sendmail" you've to set the
sendmail directive.
</p>
<h2><a name="formail">formail</a></h2>
<strong>Syntax:</strong> formail <em>path_to_formail</em><br>
<strong>Default:</strong> "formail"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
mailcfg.cgi uses the path_to_formail in ~/.procmailrc, by default the basename 'forname' is used.
</p>
<h2><a name="domain">domain</a></h2>
<strong>Syntax:</strong> domain <em>domain_name</em><br>
<strong>Default:</strong> nisdomain or domain name in
/etc/resolv.conf<br>
<strong>Context:</strong> <mailcfg>
<p>
A "X-loop: user@domainname" header is added to the forwarded or the
replied mail to avoid mail looping. With the domain directive you can set
the domainname in the "X-loop" header. If domain is not set mailcfg.cgi
will use hostname.nisadomainname, if your server isn't part of a NIS
domain it'll use the domain in /etc/resolv.conf.
</p>
<h2><a name="use_statefile">use_statefile</a></h2>
<strong>Syntax:</strong> use_statefile <em>yes|no</em>
<strong>Default</strong> no<br>
<strong>Context:</strong> <mailcfg>
<p>
CGIpaf creates a state file ( $HOME/.cgipaf_state ) in the user's home directory.
This file contains the user's current mail configuration state. This file is used by
<a href="#run_before_mailcfg">run_before_mailcfg</a>, <a href="#run_after_mailcfg">run_after_mailcfg</a> and <a href="#run_mailcfg">run_mailcfg</a>.
<br>
By default viewmailcfg.cgi doesn't use this file ( mainly for compatibility reasons ),
but reads the user's .procmailrc to determine the user mail configuration.
If you set "use_statefile" to "yes" viewmailcfg.cgi will read the state file instead
of the user's .procmailrc to get the user's current mail configuration.
<br>
If your user's uses their own .procmailrc to distribute their mailinglists into separated
mailboxes you must set "use_statefile" to "yes". The user's original .procmailrc
could confuse CGIpaf.
</p>
<h2><a name="run_success">run_success</a></h2>
<strong>Syntax:</strong> run_success <em>path_to_script</em>
<em>stdout</em><br>
<strong>Default:</strong> not set<br>
<strong>Run as:</strong> root<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
runs a script is a password / mail configuration is successfully
updated. Example:
</p>
<pre><tt><code>
run_success "/usr/sbin/smbpasswd -U %{name} > /dev/null 2>&1" "%{password}\n%{password}\n"
</code></tt></pre>
<p>
Will update the SAMBA password file.
</p>
<h2><a name="run_locked">run_locked</a></h2>
<strong>Syntax:</strong> run_locked <em>path_to_script</em>
<em>stdout</em><br>
<strong>Default:</strong> not set<br>
<strong>Run as:</strong> root<br>
<strong>Context:</strong> <passwd>, <mailcfg><br>
<p>
run a script is a user is locked.
</p>
<h2><a name="run_before_mailcfg">run_before_mailcfg</a></h2>
<strong>Syntax:</strong> run_before_mailcfg <em>script</em><br>
<strong>Default:</strong> not set<br>
<strong>Run as:</strong> <em>mail user</em><br>
<strong>Context:</strong> <mailcfg><br>
<p>
run a script before the mail configuration. mailcfg.cgi will
execute the "run_before_mailcfg" script if the mail configuration state
goes from not active ( no mail forwarding and no autoreply ) to active.
<br>
This can be used to copy the user's .procmailrc to a backup file.
<p>
<h2><a name="run_after_mailcfg">run_after_mailcfg</a></h2>
<strong>Syntax:</strong> run_after_mailcfg <em>script</em><br>
<strong>Default:</strong> not set<br>
<strong>Context:</strong> <mailcfg><br>
<p>
run a script after the mail configuration. mailcfg.cgi will
execute the "run_after_mailcfg" script if the mail configuration state
goes from active ( mail forwarding or autoreply enabled ) to non-active.
<br>
This script can be used to restore the user's .procmailrc to his original
state
</p>
<h2><a name="run_mailcfg">run_mailcfg</a></h2>
<strong>Syntax:</strong> run_mailcfg <em>path_to_script</em><br>
<strong>Default:</strong> built-in procmailrc update<br>
<strong>Run as:</strong> user<br>
<strong>Context:</strong> <mailcfg>
<p>
define a mail configuration script, if not set the built-in procmail
configuration updater is used<br>
if set, <a href="#use_statefile">use_statefile</a> is enabled.
</p>
<h2><a name="mailcfg_check">mailcfg_check</a></h2>
<strong>Syntax:</strong> mailcfg_check <em>on|off</em><br>
<strong>Default:</strong> on<br>
<strong>Context:</strong> <mailcfg>
<p>
enables or disables mailcfg.cgi internal HTTP POST parameters checking<br>
you can only disable <a href="#mailcfg_check">mailcfg_check</a> if
<a href="#run_mailcfg">run_mailcfg</a> is defined.
</p>
<p>
if disabled mailcfg.cgi will run <a href="#run_mailcfg">run_mailcfg</a> after
the authentication without testing the HTTP POST variables. This is something
you must do within your <a href="#run_mailcfg">run_mailcfg</a> script.
</p>
<p>
if <a href="#mailcfg_check">mailcfg_check</a> is disabled:
<ul>
<li>the <b>forward</b>, <b>not_forward</b>, <b>keep_msg</b>, <b>not_keep_msg</b>,
<b>autoreply</b>, <b>not_autoreply</b>, <b>autoreply_msg</b> etc
<a href="#variables">variables</a> are undefined.
</li>
<li>the <a href="#use_statefile">statefile</a> and $homedir/vacations.txt are
not updated</li>
<li><a href="#run_before_mailcfg">run_before_mailcfg</a> and
<a href="#run_after_mailcfg">run_after_mailcfg</a> are not executed</li>
</ul>
<h2><a name="run_viewmailcfg">run_viewmailcfg</a></h2>
<strong>Syntax:</strong> run_viewmailcfg <em>path_to_script</em><br>
<strong>Default:</strong> built-in <br>
<strong>Run as:</strong> user<br>
<strong>Context:</strong> <mailcfg>
<p>
defines a view mail configuration script.<br>
if not set the <a href="#mailcfg_document">mailcfg_document</a> is used
after a successful login.
</p>
<h2><a name="set_script_filename">set_script_filename</a></h2>
<strong>Syntax:</strong> set_script_filename <em>on|off</em><br>
<strong>Default:</strong> off <br>
<strong>Run as:</strong> user<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
set the SCRIPT_FILENAME environment variable to the real scriptname.
</p>
<h2><a name="unset_script_filename">unset_script_filename</a></h2>
<strong>Syntax:</strong> unset_script_filename <em>on|off</em><br>
<strong>Default:</strong> off <br>
<strong>Run as:</strong> user<br>
<strong>Context:</strong> <passwd>, <mailcfg>
<p>
unset the SCRIPT_FILENAME environment variable.
</p>
<h2><a name="cookie_timeout">cookie_timeout</a></h2>
<strong>Syntax:</strong> cookie_timeout <em>seconds</em>
<strong>Default:</strong> 300<br>
<strong>Context:</strong> <mailcfg><br>
<p>
cookie life time in seconds.
</p>
<h2><a name="mailcfg_document">mailcfg_document</a></h2>
<strong>Syntax:</strong> mailcfg_document <em>filename</em> <b>OR</b>
mailcfg_document Redirect <em>Location</em><br>
<strong>Default:</strong> built-in message<br>
<strong>Context:</strong> <mailcfg><br>
<p>
Path to the mail configuration document
</p>
<h2><a name="error_deldotforward">error_deldotforward</a></h2>
<strong>Syntax:</strong> error_deldotforward <em>filename</em> <b>OR</b>
error_deldotforward Redirect <em>Location</em><br>
<strong>Default:</strong> "Can't delete ~/.forward please contact the
webmaster"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
Unable to delete .forward
</p>
<h2><a name="error_deldotprocmailrc">error_deldotprocmailrc</a></h2>
<strong>Syntax:</strong> error_deldotprocmailrc <em>filename</em> <b>OR</b>
error_deldotprocmailrc Redirect <em>Location</em><br>
<strong>Default:</strong> "Can't delete ~/.procmailrc please contact the
webmaster"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
Unable to delete .forward
</p>
<h2><a name="error_openvacations">error_openvacations</a></h2>
<strong>Syntax:</strong> error_openvacations <em>filename</em> <b>OR</b>
error_openvacations Redirect <em>Location</em><br>
<strong>Default:</strong> "Can't open ~/.vacations.txt please contact the
webmaster"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
Unable to open ~/vacations.txt
</p>
<h2><a name="error_updateprocmailrc">error_updateprocmailrc</a></h2>
<strong>Syntax:</strong> error_updateprocmailrc <em>filename</em> <b>OR</b>
error_updateprocmailrc Redirect <em>Location</em><br>
<strong>Default:</strong> "Can't update ~/.procmailrc, please contact the webmaster"
webmaster"<br>
<strong>Context:</strong> <mailcfg><br>
<p>
Unable to update ~/.procmailrc
</p>
<h2><a name="aclorder">AclOrder</a></h2>
<strong>Syntax:</strong> AclOrder <em>Deny,All</em> <b>OR</b> <em>Allow,Deny</em><br>
<strong>Default:</strong> Deny,Allow<br>
<strong>Context:</strong> Global,<passwd>,<mailcfg>
<p>
Set the <a href="#acl">Acl</a> order.
</p>
<h2><a name="allowusers">AllowUsers</a></h2>
<strong>Syntax:</strong> AllowUsers <em>user1 user2</em> <b>OR</b> <em>*</em><br>
<strong>Default:</strong> see <a href="#acl">Access Control List</a><br>
<strong>Context:</strong> Global,<passwd>,<mailcfg>
<p>
Specify a list of users that are allowed to use CGIpaf see <a href="#acl">Access Control List</a>
</p>
<h2><a name="denyusers">DenyUsers</a></h2>
<strong>Syntax:</strong> DenyUsers <em>user1 user2</em> <b>OR</b> <em>*</em><br>
<strong>Default:</strong> see <a href="#acl">Access Control List</a><br>
<strong>Context:</strong> Global,<passwd>,<mailcfg>
<p>
Specify a list of users that are denied to use CGIpaf see <a href="#acl">acl</a>
</p>
<h2><a name="allowgroups">AllowGroups</a></h2>
<strong>Syntax:</strong> AllowGroups <em>group1 group2</em> <b>OR</b> <em>*</em><br>
<strong>Default:</strong> see <a href="#acl">Access Control List</a><br>
<strong>Context:</strong> Global,<passwd>,<mailcfg>
<p>
Specify a list of groups that are allowed to use CGIpaf see <a href="#acl">acl</a>
</p>
<h2><a name="denygroups">DenyGroups</a></h2>
<strong>Syntax:</strong> DenyGroups <em>group1 group2</em> <b>OR</b> <em>*</em><br>
<strong>Default:</strong> see <a href="#acl">Access Control List</a><br>
<strong>Context:</strong> Global,<passwd>,<mailcfg>
<p>
Specify a list of groups that are denied to use CGIpaf see <a href="#acl">acl</a>
</p>
<h1><a name="variables">Variables</a></h1>
<p>
For each document you can as use a
<a href="#htmlfile">plain html file</a> with a few PHP
extensions (see bellow) or a <a href="#redirect">redirect</a>.
In a redirect, file or
<a href="#run_success">run_success</a> and
<a href="#run_locked">run_locked</a> you can use the following variables:
</p>
<table>
<tr><td><b>Variable name</b></td><td><b>Description</b></td></tr>
<tr><td> </td><td> </td></tr>
<tr><td><b>name</b></td><td>loginname</td></tr>
<tr><td><b>min_length</b></td><td>minimum password length</td></tr>
<tr><td><b>max_length</b></td><td>maximum password length</td></tr>
<tr><td><b>max_invalid</b></td><td>maximum invalid tries</td></tr>
<tr><td><b>invalid_timeout</b></td><td>time in seconds that a user
will be locked out if the max_invalid tries has been exceeded.</td></tr>
<tr><td><b>invalid_wait</b></td><td>a locked user will have to wait
invalid_wait seconds</td></tr>
<tr><td><b>forward_to</b></td><td>the email where the mails will
forward to</td></tr>
<tr><td><b>forward</b></td><td>if mail forwarding is enabled $forward is set
to "yes". if mail forwarding is disabled $forward is "no"</td></tr>
<tr><td><b>not_forward</b></td><td>not_forward is the reverse of forward, so
if $forward is "yes" $not_forward is "no"</td></tr>
<tr><td><b>keep_msg</b></td><td>$keep_msg is set to "yes" if the use
want to keep his forwarded mails, set to "no" otherwise</td></tr>
<tr><td><b>not_keep_msg</b></td><td>the reverse of $keep_msg</td></tr>
<tr><td><b>autoreply</b></td><td>is "yes" if the use has enabled
autoreply</td></tr>
<tr><td><b>not_autoreply</b></td><td>reverse of $autoreply</td></tr>
<tr><td><b>autoreply_msg</b></td><td>the autoreply message</td></tr>
<tr><td><b>cookietimeout</b></td><td>cookie lifetime is
seconds</td></tr>
<tr><td><b>cracklib_error</b></td><td>cracklib error message</td></tr>
<tr><td><b>bad_password</b></td><td>The new password contains a illegal word, is set to cracklib_error if there is cracklib error</td></tr>
<tr><td><b>pam_error</b></td><td>pam error message</td></tr>
<tr><td><b>password</b></td><td>the user's new password, is only set at
<a href="#run_success">run_success</a></td></tr>
<tr><td><b>mailcfg_exitcode</b></td><td>exitcode of the <a href="#run_mailcfg">run_mailcfg script</a></td></tr>
<tr><td><b>viewmailcfg_exitcode</b></td><td>exitcode of the <a href="#viewrun_mailcfg">
run_viewmailcfg script</a></td></tr>
<tr><td><b>homedir</b></td><td>the user's home directory</td></tr>
<tr><td><b>domain</b></td><td>the <a href="#domain">domain</a>name, only set by mailcfg.cgi</td></tr>
<tr><td><b>user_maildomain</b></td><td>The user maildomain ( only available if <a href="#vmail_support">vmail support</a> is enabled</td></tr>
<tr><td><b>message</b></td><td>A string with the default message</td></tr>
<tr><td><b>post_string</b></td><td>A string with the original HTTP POST</td></tr>
<tr><td><b>_POST[]</b></td><td>An associative array of variables with the original HTTP POST</td></tr>
</table>
<h1><a name="redirect">Redirect</a></h1>
<p>
example:
</p>
<pre><code><tt>
msg_success redirect /pwchanged.php?name="%{name}"
</tt></code></pre>
<p>
Will redirect to /pwchanged.php?name="loginname" after a user has succeed
to change his password.
</p>
<h1><a name="htmlfile">HTML files</a></h1>
<p>
If you don't use a redirect you can use plain html files with two PHP
extensions "include" and "echo". The same variables as by a redirect are
available.
</p>
<pre><code><tt>
<? echo $name; include "bottom.php" ?>
</tt></code></pre>
<p>
Will print the user's name and include bottom.php. Please note that the
PHP implementation is very limited. include("bottom.php") won't work for
example.
</p>
<h1><a name="command">Scripts</a></h1>
<h2><a name="command_overview">Overview</a></h2>
<ul>
<li>
With <a href="#run_success">run_success</a> it's possible to run a script
when a has update his password/mail configuration.
</li>
<li><a href="#run_locked">run_locked</a> allow you to run a script when a user
has <a href="#max_invalid">too many invalid logins</a>.
</li>
<li><a href="#run_before_mailcfg">run_before_mailcfg</a> and
<a href="#run_after_mailcfg">run_after_mailfg</a> allow you to run a script
before and after the mail configuration.
</li>
<li>With <a href="#run_mailcfg">run_mailcfg</a> it's possible to run script to
update the mail configuration.
</li>
<li><a href="#run_viewmailcfg">run_viewmailcfg</a> makes it possible to run a
script after a user has login successfully to viewmailcfg.cgi
</li>
</ul>
<h2><a name="command_syntax">Syntax</a></h2>
<p>
The first argument is the script name, the second argument is send to
stdout. The second argument is usually used to pass the new password to
a script.
</p>
<h2><a name="command_examples">Examples</a></h2>
<p>
<pre><tt><code>
<passwd>
...
run_success "/usr/sbin/smbpasswd -U %{name} > /dev/null 2>&1" "%{password}\n%{password}\n"
...
</passwd>
</code></tt></pre>
<p>
Executes a script to update the SAMBA password file after the system password
is updated.
</p>
<pre><tt><code>
<mailcfg>
...
mailcfg_check off
run_viewmailcfg /etc/cgipaf/scripts/mailcfg.pl "%{poststring}"
run_mailcfg "/etc/cgipaf/scripts/mailcfg.pl update %{domain}" "%{poststring}"
...
</mailcfg>
</code></tt></pre>
<p>
Emulates a cgi environment for the mail configuration.<br>
The original http post is send back to stdout.<br>
mailcfg.cgi doesn't evaluate the httpd parameters since
<a href="#mailcfg_check">mailcfg_check</a> is disabled. This way CGIpaf
only handles the authentication.
</p>
<h1><a name="acl">Access Control List</a></h1>
<p>
With the Access Control list you can allow or deny users or groups.
</p>
<p>
The <a href="#aclorder">AclOrder</a> directive control the default access state and the order in which the acl is processed.
</p>
<dl>
<dt>Allow,Deny</dt>
<dd>The <a href="#allowusers">AllowUsers</a> and <a href="#allowgroups">AllowGroups</a> directives are evaluated before the <a href="#denyusers">DenyUsers</a> and <a href="#denygroups">DenyGroups</a> directives. Access is denied by default.</dd>
<dt>Deny,Allow</dt>
<dd>The <a href="#denyusers">DenyUsers</a> and <a href="#denygroups">DenyGroups</a> directives are evaluated before the <a href="#allowusers">AllowUsers</a> and <a href="#allowgroups">AllowGroups></a>. Access is granted by default.</dd>
</dl>
<p>
A star (*) in the user or group list means any user or group other wildcards are not supported.
</p>
<p>
<h2><a name="aclexamples">Examples</a></h2>
<pre><code>
AclOrder Deny,Allow
DenyUsers *
AllowUsers foo
</code></pre>
<p>
Access to user "foo" will be allowed and all others will be denied.
</p>
<pre><code>
AclOrder Allow,Deny
AllowUsers foo