Use new directives and link relations

This commit is contained in:
Jan Dittberner 2018-11-09 18:38:45 +01:00
parent c45018910c
commit 2b6e2746c5
5 changed files with 622 additions and 2196 deletions

View file

@ -1,384 +1,146 @@
.. index:: pages
=======================
Directory :file:`pages`
=======================
This directory only contains other (sub-) directorys, structured according to specific topics.
.. index:: pages/account .. index:: pages/account
Directory :file:`pages/account` Directory :file:`pages/account`
=============================== ===============================
.. _pages-account-0.php: .. sourcefile:: pages/account/0.php
.. sourcefile: pages/account/0.php .. sourcefile:: pages/account/1.php
- :file:`0.php` .. sourcefile:: pages/account/2.php
.. _pages-account-1.php: .. sourcefile:: pages/account/3.php
.. sourcefile: pages/account/1.php .. sourcefile:: pages/account/4.php
- :file:`1.php` .. sourcefile:: pages/account/5.php
.. _pages-account-2.php: .. sourcefile:: pages/account/6.php
.. sourcefile: pages/account/2.php .. sourcefile:: pages/account/7.php
- :file:`2.php` .. sourcefile:: pages/account/8.php
.. _pages-account-3.php: .. sourcefile:: pages/account/9.php
.. sourcefile: pages/account/3.php .. sourcefile:: pages/account/10.php
- :file:`3.php` .. sourcefile:: pages/account/11.php
.. _pages-account-4.php: .. sourcefile:: pages/account/12.php
.. sourcefile: pages/account/4.php .. sourcefile:: pages/account/13.php
- :file:`4.php` .. sourcefile:: pages/account/14.php
.. _pages-account-5.php: .. sourcefile:: pages/account/15.php
.. sourcefile: pages/account/5.php .. sourcefile:: pages/account/16.php
- :file:`5.php` .. sourcefile:: pages/account/17.php
.. _pages-account-6.php: .. sourcefile:: pages/account/18.php
.. sourcefile: pages/account/6.php .. sourcefile:: pages/account/19.php
- :file:`6.php` .. sourcefile:: pages/account/20.php
.. _pages-account-7.php: .. sourcefile:: pages/account/21.php
.. sourcefile: pages/account/7.php .. sourcefile:: pages/account/22.php
- :file:`7.php` .. sourcefile:: pages/account/23.php
.. _pages-account-8.php: .. sourcefile:: pages/account/24.php
.. sourcefile: pages/account/8.php .. sourcefile:: pages/account/25.php
- :file:`8.php` .. sourcefile:: pages/account/26.php
.. _pages-account-9.php: .. sourcefile:: pages/account/27.php
.. sourcefile: pages/account/9.php .. sourcefile:: pages/account/28.php
- :file:`9.php` .. sourcefile:: pages/account/29.php
.. _pages-account-10.php: .. sourcefile:: pages/account/30.php
.. sourcefile: pages/account/10.php .. sourcefile:: pages/account/31.php
- :file:`10.php` .. sourcefile:: pages/account/32.php
.. _pages-account-11.php: .. sourcefile:: pages/account/33.php
.. sourcefile: pages/account/11.php .. sourcefile:: pages/account/34.php
- :file:`11.php` .. sourcefile:: pages/account/35.php
.. _pages-account-12.php: .. sourcefile:: pages/account/36.php
.. sourcefile: pages/account/12.php .. sourcefile:: pages/account/37.php
- :file:`12.php` .. sourcefile:: pages/account/38.php
.. _pages-account-13.php: .. sourcefile:: pages/account/39.php
.. sourcefile: pages/account/13.php .. sourcefile:: pages/account/40.php
- :file:`13.php` .. sourcefile:: pages/account/41.php
.. _pages-account-14.php: .. sourcefile:: pages/account/42.php
.. sourcefile: pages/account/14.php .. sourcefile:: pages/account/43.php
- :file:`14.php` .. sourcefile:: pages/account/44.php
.. _pages-account-15.php: .. sourcefile:: pages/account/45.php
.. sourcefile: pages/account/15.php .. sourcefile:: pages/account/46.php
- :file:`15.php` .. sourcefile:: pages/account/47.php
.. _pages-account-16.php: .. sourcefile:: pages/account/48.php
.. sourcefile: pages/account/16.php .. sourcefile:: pages/account/49.php
- :file:`16.php` .. sourcefile:: pages/account/50.php
.. _pages-account-17.php: .. sourcefile:: pages/account/51.php
.. sourcefile: pages/account/17.php .. sourcefile:: pages/account/52.php
- :file:`17.php` .. sourcefile:: pages/account/53.php
.. _pages-account-18.php: .. sourcefile:: pages/account/54.php
.. sourcefile: pages/account/18.php .. sourcefile:: pages/account/55.php
- :file:`18.php` .. sourcefile:: pages/account/56.php
.. _pages-account-19.php: .. sourcefile:: pages/account/57.php
.. sourcefile: pages/account/19.php .. sourcefile:: pages/account/58.php
- :file:`19.php` .. sourcefile:: pages/account/59.php
.. _pages-account-20.php:
.. sourcefile: pages/account/20.php
- :file:`20.php`
.. _pages-account-21.php:
.. sourcefile: pages/account/21.php
- :file:`21.php`
.. _pages-account-22.php:
.. sourcefile: pages/account/22.php
- :file:`22.php`
.. _pages-account-23.php:
.. sourcefile: pages/account/23.php
- :file:`23.php`
.. _pages-account-24.php:
.. sourcefile: pages/account/24.php
- :file:`24.php`
.. _pages-account-25.php:
.. sourcefile: pages/account/25.php
- :file:`25.php`
.. _pages-account-26.php:
.. sourcefile: pages/account/26.php
- :file:`26.php`
.. _pages-account-27.php:
.. sourcefile: pages/account/27.php
- :file:`27.php`
.. _pages-account-28.php:
.. sourcefile: pages/account/28.php
- :file:`28.php`
.. _pages-account-29.php:
.. sourcefile: pages/account/29.php
- :file:`29.php`
.. _pages-account-30.php:
.. sourcefile: pages/account/30.php
- :file:`30.php`
.. _pages-account-31.php:
.. sourcefile: pages/account/31.php
- :file:`31.php`
.. _pages-account-32.php:
.. sourcefile: pages/account/32.php
- :file:`32.php`
.. _pages-account-33.php:
.. sourcefile: pages/account/33.php
- :file:`33.php`
.. _pages-account-34.php:
.. sourcefile: pages/account/34.php
- :file:`34.php`
.. _pages-account-35.php:
.. sourcefile: pages/account/35.php
- :file:`35.php`
.. _pages-account-36.php:
.. sourcefile: pages/account/36.php
- :file:`36.php`
.. _pages-account-37.php:
.. sourcefile: pages/account/37.php
- :file:`37.php`
.. _pages-account-38.php:
.. sourcefile: pages/account/38.php
- :file:`38.php`
.. _pages-account-39.php:
.. sourcefile: pages/account/39.php
- :file:`39.php`
.. _pages-account-40.php:
.. sourcefile: pages/account/40.php
- :file:`40.php`
.. _pages-account-41.php:
.. sourcefile: pages/account/41.php
- :file:`41.php`
.. _pages-account-42.php:
.. sourcefile: pages/account/42.php
- :file:`42.php`
.. _pages-account-43.php:
.. sourcefile: pages/account/43.php
- :file:`43.php`
.. _pages-account-44.php:
.. sourcefile: pages/account/44.php
- :file:`44.php`
.. _pages-account-45.php:
.. sourcefile: pages/account/45.php
- :file:`45.php`
.. _pages-account-46.php:
.. sourcefile: pages/account/46.php
- :file:`46.php`
.. _pages-account-47.php:
.. sourcefile: pages/account/47.php
- :file:`47.php`
.. _pages-account-48.php:
.. sourcefile: pages/account/48.php
- :file:`48.php`
.. _pages-account-49.php:
.. sourcefile: pages/account/49.php
- :file:`49.php`
.. _pages-account-50.php:
.. sourcefile: pages/account/50.php
- :file:`50.php`
.. _pages-account-51.php:
.. sourcefile: pages/account/51.php
- :file:`51.php`
.. _pages-account-52.php:
.. sourcefile: pages/account/52.php
- :file:`52.php`
.. _pages-account-53.php:
.. sourcefile: pages/account/53.php
- :file:`53.php`
.. _pages-account-54.php:
.. sourcefile: pages/account/54.php
- :file:`54.php`
.. _pages-account-55.php:
.. sourcefile: pages/account/55.php
- :file:`55.php`
.. _pages-account-56.php:
.. sourcefile: pages/account/56.php
- :file:`56.php`
.. _pages-account-57.php:
.. sourcefile: pages/account/57.php
- :file:`57.php`
.. _pages-account-58.php:
.. sourcefile: pages/account/58.php
- :file:`58.php`
.. _pages-account-59.php:
.. sourcefile: pages/account/59.php
- :file:`59.php`
.. index:: pages/advertising .. index:: pages/advertising
Directory :file:`pages/advertising` Directory :file:`pages/advertising`
=================================== ===================================
.. _pages-advertising-0.php: .. sourcefile:: pages/advertising/0.php
.. sourcefile: pages/advertising/0.php .. sourcefile:: pages/advertising/1.php
- :file:`0.php`
.. _pages-advertising-1.php:
.. sourcefile: pages/advertising/1.php
- :file:`1.php`
.. index:: pages/disputes .. index:: pages/disputes
@ -386,335 +148,131 @@ Directory :file:`pages/advertising`
Directory :file:`pages/disputes` Directory :file:`pages/disputes`
================================ ================================
.. _pages-disputes-0.php: .. sourcefile:: pages/disputes/0.php
.. sourcefile: pages/disputes/0.php .. sourcefile:: pages/disputes/1.php
- :file:`0.php` .. sourcefile:: pages/disputes/2.php
.. _pages-disputes-1.php: .. sourcefile:: pages/disputes/3.php
.. sourcefile: pages/disputes/1.php .. sourcefile:: pages/disputes/4.php
- :file:`1.php` .. sourcefile:: pages/disputes/5.php
.. _pages-disputes-2.php: .. sourcefile:: pages/disputes/6.php
.. sourcefile: pages/disputes/2.php
- :file:`2.php`
.. _pages-disputes-3.php:
.. sourcefile: pages/disputes/3.php
- :file:`3.php`
.. _pages-disputes-4.php:
.. sourcefile: pages/disputes/4.php
- :file:`4.php`
.. _pages-disputes-5.php:
.. sourcefile: pages/disputes/5.php
- :file:`5.php`
.. _pages-disputes-6.php:
.. sourcefile: pages/disputes/6.php
- :file:`6.php`
.. index:: pages/gpg .. index:: pages/gpg
Directory :file:`pages/gpg` Directory :file:`pages/gpg`
=========================== ===========================
.. _pages-gpg-0.php: .. sourcefile:: pages/gpg/0.php
.. sourcefile: pages/gpg/0.php .. sourcefile:: pages/gpg/2.php
- :file:`0.php` .. sourcefile:: pages/gpg/3.php
.. _pages-gpg-2.php:
.. sourcefile: pages/gpg/2.php
- :file:`2.php`
.. _pages-gpg-3.php:
.. sourcefile: pages/gpg/3.php
- :file:`3.php`
.. index:: pages/help .. index:: pages/help
Directory :file:`pages/help` Directory :file:`pages/help`
============================ ============================
.. _pages-help-0.php: .. sourcefile:: pages/help/0.php
.. sourcefile: pages/help/0.php .. sourcefile:: pages/help/2.php
- :file:`0.php` .. sourcefile:: pages/help/3.php
.. _pages-help-2.php: .. sourcefile:: pages/help/4.php
.. sourcefile: pages/help/2.php .. sourcefile:: pages/help/5.php
- :file:`2.php` .. sourcefile:: pages/help/6.php
.. _pages-help-3.php: .. sourcefile:: pages/help/7.php
.. sourcefile: pages/help/3.php .. sourcefile:: pages/help/8.php
- :file:`3.php` .. sourcefile:: pages/help/9.php
.. _pages-help-4.php:
.. sourcefile: pages/help/4.php
- :file:`4.php`
.. _pages-help-5.php:
.. sourcefile: pages/help/5.php
- :file:`5.php`
.. _pages-help-6.php:
.. sourcefile: pages/help/6.php
- :file:`6.php`
.. _pages-help-7.php:
.. sourcefile: pages/help/7.php
- :file:`7.php`
.. _pages-help-8.php:
.. sourcefile: pages/help/8.php
- :file:`8.php`
.. _pages-help-9.php:
.. sourcefile: pages/help/9.php
- :file:`9.php`
.. index:: pages/index .. index:: pages/index
Directory :file:`pages/index` Directory :file:`pages/index`
=============================== ===============================
.. _pages-index-0.php: .. sourcefile:: pages/index/0.php
.. sourcefile: pages/index/0.php .. sourcefile:: pages/index/1.php
- :file:`0.php` .. sourcefile:: pages/index/2.php
.. _pages-index-1.php: .. sourcefile:: pages/index/3.php
.. sourcefile: pages/index/1.php .. sourcefile:: pages/index/4.php
- :file:`1.php` .. sourcefile:: pages/index/5.php
.. _pages-index-2.php: .. sourcefile:: pages/index/6.php
.. sourcefile: pages/index/2.php .. sourcefile:: pages/index/7.php
- :file:`2.php` .. sourcefile:: pages/index/8.php
.. _pages-index-3.php: .. sourcefile:: pages/index/10.php
.. sourcefile: pages/index/3.php .. sourcefile:: pages/index/11.php
- :file:`3.php` .. sourcefile:: pages/index/12.php
.. _pages-index-4.php: .. sourcefile:: pages/index/13.php
.. sourcefile: pages/index/4.php .. sourcefile:: pages/index/16.php
- :file:`4.php` .. sourcefile:: pages/index/17.php
.. _pages-index-5.php: .. sourcefile:: pages/index/18.php
.. sourcefile: pages/index/5.php .. sourcefile:: pages/index/19.php
- :file:`5.php` .. sourcefile:: pages/index/21.php
.. _pages-index-6.php: .. sourcefile:: pages/index/47.php
.. sourcefile: pages/index/6.php .. sourcefile:: pages/index/51.php
- :file:`6.php`
.. _pages-index-7.php:
.. sourcefile: pages/index/7.php
- :file:`7.php`
.. _pages-index-8.php:
.. sourcefile: pages/index/8.php
- :file:`8.php`
.. _pages-index-10.php:
.. sourcefile: pages/index/10.php
- :file:`10.php`
.. _pages-index-11.php:
.. sourcefile: pages/index/11.php
- :file:`11.php`
.. _pages-index-12.php:
.. sourcefile: pages/index/12.php
- :file:`12.php`
.. _pages-index-13.php:
.. sourcefile: pages/index/13.php
- :file:`13.php`
.. _pages-index-16.php:
.. sourcefile: pages/index/16.php
- :file:`16.php`
.. _pages-index-17.php:
.. sourcefile: pages/index/17.php
- :file:`17.php`
.. _pages-index-18.php:
.. sourcefile: pages/index/18.php
- :file:`18.php`
.. _pages-index-19.php:
.. sourcefile: pages/index/19.php
- :file:`19.php`
.. _pages-index-21.php:
.. sourcefile: pages/index/21.php
- :file:`21.php`
.. _pages-index-47.php:
.. sourcefile: pages/index/47.php
- :file:`47.php`
.. _pages-index-51.php:
.. sourcefile: pages/index/51.php
- :file:`51.php`
.. index:: pages/wot .. index:: pages/wot
Directory :file:`pages/wot` Directory :file:`pages/wot`
=========================== ===========================
.. _pages-wot-0.php: .. sourcefile:: pages/wot/0.php
.. sourcefile: pages/wot/0.php .. sourcefile:: pages/wot/1.php
- :file:`0.php` .. sourcefile:: pages/wot/2.php
.. _pages-wot-1.php: .. sourcefile:: pages/wot/3.php
.. sourcefile: pages/wot/1.php .. sourcefile:: pages/wot/4.php
- :file:`1.php` .. sourcefile:: pages/wot/5.php
.. _pages-wot-2.php: .. sourcefile:: pages/wot/6.php
.. sourcefile: pages/wot/2.php .. sourcefile:: pages/wot/8.php
- :file:`2.php` .. sourcefile:: pages/wot/9.php
.. _pages-wot-3.php: .. sourcefile:: pages/wot/10.php
.. sourcefile: pages/wot/3.php .. sourcefile:: pages/wot/12.php
- :file:`3.php` .. sourcefile:: pages/wot/13.php
.. _pages-wot-4.php: .. sourcefile:: pages/wot/15.php
.. sourcefile: pages/wot/4.php
- :file:`4.php`
.. _pages-wot-5.php:
.. sourcefile: pages/wot/5.php
- :file:`5.php`
.. _pages-wot-6.php:
.. sourcefile: pages/wot/6.php
- :file:`6.php`
.. _pages-wot-8.php:
.. sourcefile: pages/wot/8.php
- :file:`8.php`
.. _pages-wot-9.php:
.. sourcefile: pages/wot/9.php
- :file:`9.php`
.. _pages-wot-10.php:
.. sourcefile: pages/wot/10.php
- :file:`10.php`
.. _pages-wot-12.php:
.. sourcefile: pages/wot/12.php
- :file:`12.php`
.. _pages-wot-13.php:
.. sourcefile: pages/wot/13.php
- :file:`13.php`
.. _pages-wot-15.php:
.. sourcefile: pages/wot/15.php
- :file:`15.php`

View file

@ -1,605 +1,213 @@
.. _scripts-49de-lt2013-berlin-email.txt: =========================
Directory :file:`scripts`
=========================
.. sourcefile: scripts/49de-lt2013-berlin-email.txt .. sourcefile:: scripts/49de-lt2013-berlin-email.txt
- :file:`49de-lt2013-berlin-email.txt` .. sourcefile:: scripts/49de-lt2013-berlin-mail.php.txt
.. _scripts-49de-lt2013-berlin-mail.php.txt: .. sourcefile:: scripts/50de-ate-luebeck-email.txt
.. sourcefile: scripts/49de-lt2013-berlin-mail.php.txt .. sourcefile:: scripts/50de-ate-luebeck-mail.php.txt
- :file:`49de-lt2013-berlin-mail.php.txt` .. sourcefile:: scripts/51at-ate-graz-email.txt
.. _scripts-50de-ate-luebeck-email.txt: .. sourcefile:: scripts/51at-ate-graz-mail.php.txt
.. sourcefile: scripts/50de-ate-luebeck-email.txt .. sourcefile:: scripts/52at-ate-wien-email.txt
- :file:`50de-ate-luebeck-email.txt` .. sourcefile:: scripts/52at-ate-wien-mail.php.txt
.. _scripts-50de-ate-luebeck-mail.php.txt: .. sourcefile:: scripts/53de-ate-amberg-email.txt
.. sourcefile: scripts/50de-ate-luebeck-mail.php.txt .. sourcefile:: scripts/53de-ate-amberg-mail.php.txt
- :file:`50de-ate-luebeck-mail.php.txt` .. sourcefile:: scripts/54at-ate-linz-email.txt
.. _scripts-51at-ate-graz-email.txt: .. sourcefile:: scripts/54at-ate-linz-mail.php.txt
.. sourcefile: scripts/51at-ate-graz-email.txt .. sourcefile:: scripts/55de-ate-wiesbaden-email.txt
- :file:`51at-ate-graz-email.txt` .. sourcefile:: scripts/55de-ate-wiesbaden-mail.php.txt
.. _scripts-51at-ate-graz-mail.php.txt: .. sourcefile:: scripts/56at-ate-oberwart-email.txt
.. sourcefile: scripts/51at-ate-graz-mail.php.txt .. sourcefile:: scripts/56at-ate-oberwart-mail.php.txt
- :file:`51at-ate-graz-mail.php.txt` .. sourcefile:: scripts/57at-ate-graz-email.txt
.. _scripts-52at-ate-wien-email.txt: .. sourcefile:: scripts/57at-ate-graz-mail.php.txt
.. sourcefile: scripts/52at-ate-wien-email.txt .. sourcefile:: scripts/58at-ate-wien-email.txt
- :file:`52at-ate-wien-email.txt` .. sourcefile:: scripts/58at-ate-wien-mail.php.txt
.. _scripts-52at-ate-wien-mail.php.txt: .. sourcefile:: scripts/59de-ate-freiburg-email.txt
.. sourcefile: scripts/52at-ate-wien-mail.php.txt .. sourcefile:: scripts/59de-ate-freiburg-mail.php.txt
- :file:`52at-ate-wien-mail.php.txt` .. sourcefile:: scripts/60de-ate-bremen-email.txt
.. _scripts-53de-ate-amberg-email.txt: .. sourcefile:: scripts/60de-ate-bremen-mail.php.txt
.. sourcefile: scripts/53de-ate-amberg-email.txt .. sourcefile:: scripts/61de-ate-dresden-email.txt
- :file:`53de-ate-amberg-email.txt` .. sourcefile:: scripts/61de-ate-dresden-mail.php.txt
.. _scripts-53de-ate-amberg-mail.php.txt: .. sourcefile:: scripts/62de-froscon2015-email.txt
.. sourcefile: scripts/53de-ate-amberg-mail.php.txt .. sourcefile:: scripts/62de-froscon2015-mail.php.txt
- :file:`53de-ate-amberg-mail.php.txt` .. sourcefile:: scripts/63dk-ate-nykobing-email.txt
.. _scripts-54at-ate-linz-email.txt: .. sourcefile:: scripts/63dk-ate-nykobing-mail.php.txt
.. sourcefile: scripts/54at-ate-linz-email.txt .. sourcefile:: scripts/addpoints.php
- :file:`54at-ate-linz-email.txt` .. sourcefile:: scripts/assurer.php
.. _scripts-54at-ate-linz-mail.php.txt: .. sourcefile:: scripts/assurer.txt
.. sourcefile: scripts/54at-ate-linz-mail.php.txt .. sourcefile:: scripts/cleanthem.pl
- :file:`54at-ate-linz-mail.php.txt` .. sourcefile:: scripts/clientcerts.php
.. _scripts-55de-ate-wiesbaden-email.txt: .. sourcefile:: scripts/consistence.php
.. sourcefile: scripts/55de-ate-wiesbaden-email.txt .. sourcefile:: scripts/country.php
- :file:`55de-ate-wiesbaden-email.txt` .. sourcefile:: scripts/cron
.. _scripts-55de-ate-wiesbaden-mail.php.txt: .. sourcefile:: scripts/db_migrations
.. sourcefile: scripts/55de-ate-wiesbaden-mail.php.txt .. sourcefile:: scripts/DumpWeakCerts.pl
- :file:`55de-ate-wiesbaden-mail.php.txt` .. sourcefile:: scripts/findexp3.pl
.. _scripts-56at-ate-oberwart-email.txt: .. sourcefile:: scripts/findnull.pl
.. sourcefile: scripts/56at-ate-oberwart-email.txt .. sourcefile:: scripts/gpgcerts.php
- :file:`56at-ate-oberwart-email.txt` .. sourcefile:: scripts/gpgcheck3.php
.. _scripts-56at-ate-oberwart-mail.php.txt: .. sourcefile:: scripts/gpgfillmissingemail.php
.. sourcefile: scripts/56at-ate-oberwart-mail.php.txt .. sourcefile:: scripts/gpgfillmissingkeyid.php
- :file:`56at-ate-oberwart-mail.php.txt` .. sourcefile:: scripts/mail-weak-keys.php
.. _scripts-57at-ate-graz-email.txt: .. sourcefile:: scripts/Makefile
.. sourcefile: scripts/57at-ate-graz-email.txt .. sourcefile:: scripts/mass-revoke.php
- :file:`57at-ate-graz-email.txt` .. sourcefile:: scripts/newslettercebit.php
.. _scripts-57at-ate-graz-mail.php.txt: .. sourcefile:: scripts/newsletter.php
.. sourcefile: scripts/57at-ate-graz-mail.php.txt .. sourcefile:: scripts/notify.php
- :file:`57at-ate-graz-mail.php.txt` .. sourcefile:: scripts/oa03-csr_org_client_cert.php.txt
.. _scripts-58at-ate-wien-email.txt: .. sourcefile:: scripts/oa03-csr_org_client_cert.txt
.. sourcefile: scripts/58at-ate-wien-email.txt .. sourcefile:: scripts/perl_mysql.sample
- :file:`58at-ate-wien-email.txt` .. sourcefile:: scripts/resetpermissions.php
.. _scripts-58at-ate-wien-mail.php.txt: .. sourcefile:: scripts/runclient.c
.. sourcefile: scripts/58at-ate-wien-mail.php.txt .. sourcefile:: scripts/rungpg.c
- :file:`58at-ate-wien-mail.php.txt` .. sourcefile:: scripts/runserver.c
.. _scripts-59de-ate-freiburg-email.txt: .. sourcefile:: scripts/scanforexponents.php
.. sourcefile: scripts/59de-ate-freiburg-email.txt .. sourcefile:: scripts/send_heartbleed.php
- :file:`59de-ate-freiburg-email.txt` .. sourcefile:: scripts/send_policy_cca_20140916.php
.. _scripts-59de-ate-freiburg-mail.php.txt: .. sourcefile:: scripts/send_policy_cca_correct_20150221_1.php
.. sourcefile: scripts/59de-ate-freiburg-mail.php.txt .. sourcefile:: scripts/send_policy_cca_correct_20150221_2.php
- :file:`59de-ate-freiburg-mail.php.txt` .. sourcefile:: scripts/send_thawte.php.txt
.. _scripts-60de-ate-bremen-email.txt: .. sourcefile:: scripts/servercerts.php
.. sourcefile: scripts/60de-ate-bremen-email.txt .. sourcefile:: scripts/test.c
- :file:`60de-ate-bremen-email.txt`
.. _scripts-60de-ate-bremen-mail.php.txt:
.. sourcefile: scripts/60de-ate-bremen-mail.php.txt
- :file:`60de-ate-bremen-mail.php.txt`
.. _scripts-61de-ate-dresden-email.txt:
.. sourcefile: scripts/61de-ate-dresden-email.txt
- :file:`61de-ate-dresden-email.txt`
.. _scripts-61de-ate-dresden-mail.php.txt:
.. sourcefile: scripts/61de-ate-dresden-mail.php.txt
- :file:`61de-ate-dresden-mail.php.txt`
.. _scripts-62de-froscon2015-email.txt:
.. sourcefile: scripts/62de-froscon2015-email.txt
- :file:`62de-froscon2015-email.txt`
.. _scripts-62de-froscon2015-mail.php.txt:
.. sourcefile: scripts/62de-froscon2015-mail.php.txt
- :file:`62de-froscon2015-mail.php.txt`
.. _scripts-63dk-ate-nykobing-email.txt:
.. sourcefile: scripts/63dk-ate-nykobing-email.txt
- :file:`63dk-ate-nykobing-email.txt`
.. _scripts-63dk-ate-nykobing-mail.php.txt:
.. sourcefile: scripts/63dk-ate-nykobing-mail.php.txt
- :file:`63dk-ate-nykobing-mail.php.txt`
.. _scripts-addpoints.php:
.. sourcefile: scripts/addpoints.php
- :file:`addpoints.php`
.. _scripts-assurer.php:
.. sourcefile: scripts/assurer.php
- :file:`assurer.php`
.. _scripts-assurer.txt:
.. sourcefile: scripts/assurer.txt
- :file:`assurer.txt`
.. _scripts-cleanthem.pl:
.. sourcefile: scripts/cleanthem.pl
- :file:`cleanthem.pl`
.. _scripts-clientcerts.php:
.. sourcefile: scripts/clientcerts.php
- :file:`clientcerts.php`
.. _scripts-consistence.php:
.. sourcefile: scripts/consistence.php
- :file:`consistence.php`
.. _scripts-country.php:
.. sourcefile: scripts/country.php
- :file:`country.php`
.. _scripts-cron:
.. sourcefile: scripts/cron
- :file:`cron`
.. _scripts-db_migrations:
.. sourcefile: scripts/db_migrations
- :file:`db_migrations`
.. _scripts-DumpWeakCerts.pl:
.. sourcefile: scripts/DumpWeakCerts.pl
- :file:`DumpWeakCerts.pl`
.. _scripts-findexp3.pl:
.. sourcefile: scripts/findexp3.pl
- :file:`findexp3.pl`
.. _scripts-findnull.pl:
.. sourcefile: scripts/findnull.pl
- :file:`findnull.pl`
.. _scripts-gpgcerts.php:
.. sourcefile: scripts/gpgcerts.php
- :file:`gpgcerts.php`
.. _scripts-gpgcheck3.php:
.. sourcefile: scripts/gpgcheck3.php
- :file:`gpgcheck3.php`
.. _scripts-gpgfillmissingemail.php:
.. sourcefile: scripts/gpgfillmissingemail.php
- :file:`gpgfillmissingemail.php`
.. _scripts-gpgfillmissingkeyid.php:
.. sourcefile: scripts/gpgfillmissingkeyid.php
- :file:`gpgfillmissingkeyid.php`
.. _scripts-mailing archive:
.. sourcefile: scripts/mailing archive
- :file:`mailing archive`
.. _scripts-mail-weak-keys.php:
.. sourcefile: scripts/mail-weak-keys.php
- :file:`mail-weak-keys.php`
.. _scripts-Makefile:
.. sourcefile: scripts/Makefile
- :file:`Makefile`
.. _scripts-mass-revoke.php:
.. sourcefile: scripts/mass-revoke.php
- :file:`mass-revoke.php`
.. _scripts-newslettercebit.php:
.. sourcefile: scripts/newslettercebit.php
- :file:`newslettercebit.php`
.. _scripts-newsletter.php:
.. sourcefile: scripts/newsletter.php
- :file:`newsletter.php`
.. _scripts-notify.php:
.. sourcefile: scripts/notify.php
- :file:`notify.php`
.. _scripts-oa03-csr_org_client_cert.php.txt:
.. sourcefile: scripts/oa03-csr_org_client_cert.php.txt
- :file:`oa03-csr_org_client_cert.php.txt`
.. _scripts-oa03-csr_org_client_cert.txt:
.. sourcefile: scripts/oa03-csr_org_client_cert.txt
- :file:`oa03-csr_org_client_cert.txt`
.. _scripts-perl_mysql.sample:
.. sourcefile: scripts/perl_mysql.sample
- :file:`perl_mysql.sample`
.. _scripts-resetpermissions.php:
.. sourcefile: scripts/resetpermissions.php
- :file:`resetpermissions.php`
.. _scripts-runclient.c:
.. sourcefile: scripts/runclient.c
- :file:`runclient.c`
.. _scripts-rungpg.c:
.. sourcefile: scripts/rungpg.c
- :file:`rungpg.c`
.. _scripts-runserver.c:
.. sourcefile: scripts/runserver.c
- :file:`runserver.c`
.. _scripts-scanforexponents.php:
.. sourcefile: scripts/scanforexponents.php
- :file:`scanforexponents.php`
.. _scripts-send_heartbleed.php:
.. sourcefile: scripts/send_heartbleed.php
- :file:`send_heartbleed.php`
.. _scripts-send_policy_cca_20140916.php:
.. sourcefile: scripts/send_policy_cca_20140916.php
- :file:`send_policy_cca_20140916.php`
.. _scripts-send_policy_cca_correct_20150221_1.php:
.. sourcefile: scripts/send_policy_cca_correct_20150221_1.php
- :file:`send_policy_cca_correct_20150221_1.php`
.. _scripts-send_policy_cca_correct_20150221_2.php:
.. sourcefile: scripts/send_policy_cca_correct_20150221_2.php
- :file:`send_policy_cca_correct_20150221_2.php`
.. _scripts-send_thawte.php.txt:
.. sourcefile: scripts/send_thawte.php.txt
- :file:`send_thawte.php.txt`
.. _scripts-servercerts.php:
.. sourcefile: scripts/servercerts.php
- :file:`servercerts.php`
.. _scripts-test.c:
.. sourcefile: scripts/test.c
- :file:`test.c`
Directory :file:`scripts/cron` Directory :file:`scripts/cron`
============================== ==============================
.. _scripts-cron-permissionreview.php: .. sourcefile:: scripts/cron/permissionreview.php
.. sourcefile: scripts/cron/permissionreview.php .. sourcefile:: scripts/cron/refresh_stats.php
- :file:`permissionreview.php` .. sourcefile:: scripts/cron/removedead.php
.. _scripts-cron-refresh_stats.php: .. sourcefile:: scripts/cron/updatesort.php
.. sourcefile: scripts/cron/refresh_stats.php .. sourcefile:: scripts/cron/warning.php
- :file:`refresh_stats.php`
.. _scripts-cron-removedead.php:
.. sourcefile: scripts/cron/removedead.php
- :file:`removedead.php`
.. _scripts-cron-updatesort.php:
.. sourcefile: scripts/cron/updatesort.php
- :file:`updatesort.php`
.. _scripts-cron-warning.php:
.. sourcefile: scripts/cron/warning.php
- :file:`warning.php`
.. index:: bash .. index:: bash
Directory :file:`scripts/db_migrations` Directory :file:`scripts/db_migrations`
======================================= =======================================
.. _scripts-db_migrations-version1.sh: .. sourcefile:: scripts/db_migrations/version1.sh
.. sourcefile: scripts/db_migrations/version1.sh .. sourcefile:: scripts/db_migrations/version2.sh
- :file:`version1.sh` .. sourcefile:: scripts/db_migrations/version3.sh
.. _scripts-db_migrations-version2.sh: .. sourcefile:: scripts/db_migrations/version4.sh
.. sourcefile: scripts/db_migrations/version2.sh .. sourcefile:: scripts/db_migrations/version5.sh
- :file:`version2.sh` .. sourcefile:: scripts/db_migrations/version6.sh
.. _scripts-db_migrations-version3.sh:
.. sourcefile: scripts/db_migrations/version3.sh
- :file:`version3.sh`
.. _scripts-db_migrations-version4.sh:
.. sourcefile: scripts/db_migrations/version4.sh
- :file:`version4.sh`
.. _scripts-db_migrations-version5.sh:
.. sourcefile: scripts/db_migrations/version5.sh
- :file:`version5.sh`
.. _scripts-db_migrations-version6.sh:
.. sourcefile: scripts/db_migrations/version6.sh
- :file:`version6.sh`
Directory :file:`scripts/mailing archive` Directory :file:`scripts/mailing archive`
========================================= =========================================
.. _scripts-mailing archive-45au-ate-melbourne-email.txt: .. sourcefile:: scripts/mailing_archive/45au-ate-melbourne-email.txt
.. sourcefile: scripts/mailing archive/45au-ate-melbourne-email.txt .. sourcefile:: scripts/mailing_archive/45au-ate-melbourne-mail.php.txt
- :file:`45au-ate-melbourne-email.txt` .. sourcefile:: scripts/mailing_archive/46us-ate-raleigh-email.txt
.. _scripts-mailing archive-45au-ate-melbourne-mail.php.txt: .. sourcefile:: scripts/mailing_archive/46us-ate-raleigh-mail.php.txt
.. sourcefile: scripts/mailing archive/45au-ate-melbourne-mail.php.txt .. sourcefile:: scripts/mailing_archive/47us-fudcon-lawrence-email.txt
- :file:`45au-ate-melbourne-mail.php.txt` .. sourcefile:: scripts/mailing_archive/47us-fudcon-lawrence-mail.php.txt
.. _scripts-mailing archive-46us-ate-raleigh-email.txt: .. sourcefile:: scripts/mailing_archive/48de-ate-kiel-email.txt
.. sourcefile: scripts/mailing archive/46us-ate-raleigh-email.txt .. sourcefile:: scripts/mailing_archive/48de-ate-kiel-mail.php.txt
- :file:`46us-ate-raleigh-email.txt` .. sourcefile:: scripts/mailing_archive/oa01-allowance.php.txt
.. _scripts-mailing archive-46us-ate-raleigh-mail.php.txt: .. sourcefile:: scripts/mailing_archive/oa01-allowance.txt
.. sourcefile: scripts/mailing archive/46us-ate-raleigh-mail.php.txt .. sourcefile:: scripts/mailing_archive/oa02-mailingtextCats.txt
- :file:`46us-ate-raleigh-mail.php.txt` .. sourcefile:: scripts/mailing_archive/oa02-mailingtextPointsCats.txt
.. _scripts-mailing archive-47us-fudcon-lawrence-email.txt: .. sourcefile:: scripts/mailing_archive/oa02-mailingtextPoints.txt
.. sourcefile: scripts/mailing archive/47us-fudcon-lawrence-email.txt .. sourcefile:: scripts/mailing_archive/oa02-orgainformation.php.txt
- :file:`47us-fudcon-lawrence-email.txt` .. sourcefile:: scripts/mailing_archive/thawte_DE.txt
.. _scripts-mailing archive-47us-fudcon-lawrence-mail.php.txt: .. sourcefile:: scripts/mailing_archive/thawte_EN.txt
.. sourcefile: scripts/mailing archive/47us-fudcon-lawrence-mail.php.txt .. sourcefile:: scripts/mailing_archive/thawte_ES.txt
- :file:`47us-fudcon-lawrence-mail.php.txt` .. sourcefile:: scripts/mailing_archive/thawte_FR.txt
.. _scripts-mailing archive-48de-ate-kiel-email.txt: .. sourcefile:: scripts/mailing_archive/thawte_NL.txt
.. sourcefile: scripts/mailing archive/48de-ate-kiel-email.txt
- :file:`48de-ate-kiel-email.txt`
.. _scripts-mailing archive-48de-ate-kiel-mail.php.txt:
.. sourcefile: scripts/mailing archive/48de-ate-kiel-mail.php.txt
- :file:`48de-ate-kiel-mail.php.txt`
.. _scripts-mailing archive-oa01-allowance.php.txt:
.. sourcefile: scripts/mailing archive/oa01-allowance.php.txt
- :file:`oa01-allowance.php.txt`
.. _scripts-mailing archive-oa01-allowance.txt:
.. sourcefile: scripts/mailing archive/oa01-allowance.txt
- :file:`oa01-allowance.txt`
.. _scripts-mailing archive-oa02-mailingtextCats.txt:
.. sourcefile: scripts/mailing archive/oa02-mailingtextCats.txt
- :file:`oa02-mailingtextCats.txt`
.. _scripts-mailing archive-oa02-mailingtextPointsCats.txt:
.. sourcefile: scripts/mailing archive/oa02-mailingtextPointsCats.txt
- :file:`oa02-mailingtextPointsCats.txt`
.. _scripts-mailing archive-oa02-mailingtextPoints.txt:
.. sourcefile: scripts/mailing archive/oa02-mailingtextPoints.txt
- :file:`oa02-mailingtextPoints.txt`
.. _scripts-mailing archive-oa02-orgainformation.php.txt:
.. sourcefile: scripts/mailing archive/oa02-orgainformation.php.txt
- :file:`oa02-orgainformation.php.txt`
.. _scripts-mailing archive-thawte_DE.txt:
.. sourcefile: scripts/mailing archive/thawte_DE.txt
- :file:`thawte_DE.txt`
.. _scripts-mailing archive-thawte_EN.txt:
.. sourcefile: scripts/mailing archive/thawte_EN.txt
- :file:`thawte_EN.txt`
.. _scripts-mailing archive-thawte_ES.txt:
.. sourcefile: scripts/mailing archive/thawte_ES.txt
- :file:`thawte_ES.txt`
.. _scripts-mailing archive-thawte_FR.txt:
.. sourcefile: scripts/mailing archive/thawte_FR.txt
- :file:`thawte_FR.txt`
.. _scripts-mailing archive-thawte_NL.txt:
.. sourcefile: scripts/mailing archive/thawte_NL.txt
- :file:`thawte_NL.txt`
.. _scripts-mailing archive-thawte_RU.txt:
.. sourcefile: scripts/mailing archive/thawte_RU.txt
- :file:`thawte_RU.txt`
.. sourcefile:: scripts/mailing_archive/thawte_RU.txt

File diff suppressed because it is too large Load diff

View file

@ -14,6 +14,17 @@ The root directory contains
.. _GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0 .. _GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0
.. toctree::
:maxdepth: 2
:caption: Documentation for subdirectories
:name: directorytoc
DIR-pages
DIR-scripts
DIR-www
.. index:: cgi-bin .. index:: cgi-bin
Directory :file:`cgi-bin` Directory :file:`cgi-bin`
@ -23,14 +34,16 @@ The `cgi-bin` directory contains
.. index:: PHP .. index:: PHP
.. _cgi-bin-siteseal-cgi: .. sourcefile:: cgi-bin/siteseal.cgi
:links:
www/sealgen.php
- :file:`siteseal.cgi` a PHP CGI script that generates some JavaScript code a PHP CGI script that generates some JavaScript code to invoke
to invoke :ref:`sealgen.php <www-sealgen-php>`. The configuration on :sourcefile:`sealgen.php <www/sealgen.php>`. The configuration on
www.cacert.org does not seem to support this script www.cacert.org does not seem to support this script
https://www.cacert.org/cgi-bin/siteseal.cgi returns a 403 response. https://www.cacert.org/cgi-bin/siteseal.cgi returns a 403 response.
.. todo: check whether this is linked anywhere or can be removed .. todo: check whether this is linked anywhere or can be removed
.. index:: commModule .. index:: commModule
.. index:: Perl .. index:: Perl
@ -41,290 +54,267 @@ Directory :file:`CommModule`
This directory contains the CommModule that is implemented in Perl: This directory contains the CommModule that is implemented in Perl:
.. _commmodule-client-pl: .. sourcefile:: CommModule/client.pl
:uses:
includes/mysql.php
- :file:`client.pl` the :doc:`signer protocol <signer>` client, running :file:`client.pl` implements the :doc:`signer protocol <signer>` client,
on the webserver and talking to the server via a serial link. running on the webserver and talking to the server via a serial link.
The style of the Perl code seems a bit inconsistent (mix of uppercase and The style of the Perl code seems a bit inconsistent (mix of uppercase and
lowercase function names, usage of brackets). The code uses database polling lowercase function names, usage of brackets). The code uses database polling
in a loop. It might be a better idea to use some kind of queueing (Redis, in a loop. It might be a better idea to use some kind of queueing (Redis,
AMQP, ...) to not waste resources when there is nothing to do). Function AMQP, ...) to not waste resources when there is nothing to do). Function
parameters are not named which makes the code hard to read. parameters are not named which makes the code hard to read.
The script calls several system binaries that need to be present in The script calls several system binaries that need to be present in
compatible versions: compatible versions:
- :program:`openssl` - :program:`openssl`
- :program:`xdelta` - :program:`xdelta`
The script uses several Perl standard library modules as well as the The script uses several Perl standard library modules as well as the
following third party modules: following third party modules:
.. index:: Perl, thirdparty .. index:: Perl, thirdparty
- `DBD::mysql <https://metacpan.org/pod/DBD::mysql>`_ - `DBD::mysql <https://metacpan.org/pod/DBD::mysql>`_
- `DBI <https://metacpan.org/pod/DBI>`_ - `DBI <https://metacpan.org/pod/DBI>`_
- `Device::SerialPort <https://metacpan.org/pod/Device::SerialPort>`_ - `Device::SerialPort <https://metacpan.org/pod/Device::SerialPort>`_
- `File::CounterFile <https://metacpan.org/pod/File::CounterFile>`_ - `File::CounterFile <https://metacpan.org/pod/File::CounterFile>`_
The script references several openssl configuration files in the HandleCerts The script references several openssl configuration files in the HandleCerts
function that are not included in the code repository. There are some function that are not included in the code repository. There are some
openssl configuration files with similar names in openssl configuration files with similar names in
https://svn.cacert.org/CAcert/SystemAdministration/signer/ https://svn.cacert.org/CAcert/SystemAdministration/signer/
The database password is parsed from The database password is parsed from
:ref:`includes/mysql.php <includes-mysql-php>` and relies on the :sourcefile:`includes/mysql.php` and relies on the
exact code that is defined there. Database name, user and host are hardcoded exact code that is defined there. Database name, user and host are hardcoded
in the DBI->connect call. in the DBI->connect call.
The script implements the client side of the signer protocol which is The script implements the client side of the signer protocol which is
specified in :doc:`signer`. specified in :doc:`signer`.
The script performs the following operations: The script performs the following operations:
- parse password from :file:`includes/mysql.php` - parse password from :sourcefile:`includes/mysql.php`
- read a list of CRL files and logs their SHA-1 hashes - read a list of CRL files and logs their SHA-1 hashes
- read :file:`serial.conf`, create a Device::SerialPort instance `$portObj`, - read :file:`serial.conf`, create a Device::SerialPort instance `$portObj`,
sets serial parameters and saves :file:`serial.conf` sets serial parameters and saves :file:`serial.conf`
- run a main loop as long as a file :file:`./client.pl-active` is present. - run a main loop as long as a file :file:`./client.pl-active` is present.
The main loop performs the following tasks The main loop performs the following tasks
- handle pending OpenPGP key signing request via ``HandleGPG()`` - handle pending OpenPGP key signing request via ``HandleGPG()``
- handle pending certificate signing requests: - handle pending certificate signing requests:
- personal client certificates via ``HandleCerts(0, 0)`` - personal client certificates via ``HandleCerts(0, 0)``
- personal server certificates via ``HandleCerts(0, 1)`` - personal server certificates via ``HandleCerts(0, 1)``
- organization client certificates via ``HandleCerts(1, 0)`` - organization client certificates via ``HandleCerts(1, 0)``
- organization server certificates via ``HandleCerts(1, 1)`` - organization server certificates via ``HandleCerts(1, 1)``
- handle pending certificate revocation requests - handle pending certificate revocation requests
- personal client certificates via ``RevokeCerts(0, 0)`` - personal client certificates via ``RevokeCerts(0, 0)``
- personal server certificates via ``RevokeCerts(0, 1)`` - personal server certificates via ``RevokeCerts(0, 1)``
- organization client certificates via ``RevokeCerts(1, 0)`` - organization client certificates via ``RevokeCerts(1, 0)``
- organization server certificates via ``RevokeCerts(1, 1)`` - organization server certificates via ``RevokeCerts(1, 1)``
- refresh :term:`CRLs <CRL>` via ``RefreshCRLs()`` in every 100st - refresh :term:`CRLs <CRL>` via ``RefreshCRLs()`` in every 100st
iteration iteration
- send a :ref:`NUL request <signer-nul-request-format>` to keep the signer - send a :ref:`NUL request <signer-nul-request-format>` to keep the signer
connection alive connection alive
- sleep for 2.7 seconds - sleep for 2.7 seconds
There is potential for optimization in the main loop. The CRL update could The script uses a lot of temporary files instead of piping input and
be performed if a certificate has been revoked. The NUL request needs only output to and from external commands.
to be sent if no other request has been sent.
The script uses a lot of temporary files instead of piping input and .. todo:: describe more in-depth what each of the main loop steps does
output to and from external commands.
.. todo:: describe more in-depth what each of the main loop steps does .. sourcefile:: CommModule/commdaemon
- :file:`commdaemon` a script to run :ref:`client.pl <commmodule-client-pl>` :file:`commdaemon` is a script to run
or :ref:`server.pl <commmodule-server-pl>` :sourcefile:`client.pl <CommModule/client.pl>`
or :sourcefile:`server.pl <CommModule/server.pl>`.
This bash script is automatically restarting the :file:`{script}` given as This bash script is automatically restarting the :file:`{script}` given as
the first parameter as long as a file :file:`{script}-active` exists. the first parameter as long as a file :file:`{script}-active` exists.
Informational messages and errors are logged to syslog via Informational messages and errors are logged to syslog via
:command:`logger`. :command:`logger`.
The script is most probably used to recover from crashed scripts. This The script is most probably used to recover from crashed scripts. This
could be implemented via :command:`supervisor` or :command:`systemd` could be implemented via :command:`supervisor` or :command:`systemd`
instead of a custom script. instead of a custom script.
- :file:`commmodule` a System V style init script for startup/shutdown of .. sourcefile:: CommModule/commmodule
CommModule
On test.cacert.org two slightly different versions are deployed in :file:`commodule` is a System V style init script for startup/shutdown of
:file:`/etc/init.d` the first version starts CommModule
:ref:`client.pl <commmodule-client-pl>` in
:file:`/home/cacert/www/CommModule/` and the
second variant starts :ref:`server.pl <commmodule-server-pl>` in
:file:`/home/signer/cacert-devel/CommModule/`.
- :file:`logclean.sh` maintenance script for logfiles generated by CommModule On test.cacert.org two slightly different versions are deployed in
:file:`/etc/init.d` the first version starts
:sourcefile:`client.pl <CommModule/client.pl>` in
:file:`/home/cacert/www/CommModule/` and the
second variant starts :sourcefile:`server.pl <CommModule/server.pl>` in
:file:`/home/signer/cacert-devel/CommModule/`.
The :file:`logclean.sh` script performs log rotation of signer logfiles. .. sourcefile:: CommModule/logclean.sh
.. todo:: :file:`logclean.sh` is a maintenance script for logfiles generated by
CommModule.
discuss replacement of this script with :command:`logrotate` and a The :file:`logclean.sh` script performs log rotation of signer logfiles.
custom logrotate.conf for the signer
- :file:`serial.conf` serial port configuration file .. todo::
This file is read and written by both discuss replacement of this script with :command:`logrotate` and a
:ref:`client.pl <commmodule-client-pl>` and custom logrotate.conf for the signer
:ref:`server.pl <commmodule-server-pl>` therefore both cannot be run from
the same directory without interfering with each other.
.. todo:: .. sourcefile:: CommModule/serial.conf
add a serial.conf template and move the actual serial.conf into `serial.conf` serial port configuration file
configuration management
.. _commmodule-server-pl: This file is read and written by both
:sourcefile:`client.pl <CommModule/client.pl>` and
:sourcefile:`server.pl <CommModule/server.pl>` therefore both cannot be run
from the same directory without interfering with each other.
- :file:`server.pl` the real server, running on the signing server .. todo::
This script implements the signer (server) side of the :doc:`signer add a serial.conf template and move the actual serial.conf into
protocol <signer>` and performs the actual signing operations. configuration management
The script contains a some code that is duplicated by .. sourcefile:: CommModule/server.pl
:ref:`client.pl <commmodule-client-pl>`.
.. note:: :file:`server.pl` is the signing server software.
The :file:`server.pl` used on test.cacert.org is different from the This script implements the signer (server) side of the :doc:`signer
version in the cacert-devel repository. The git origin is recorded as protocol <signer>` and performs the actual signing operations.
`git://git-cacert.it-sls.de/cacert-devel.git` and there are some small
uncommitted changes too.
.. todo:: The script contains a some code that is duplicated by
:sourcefile:`client.pl <CommModule/client.pl>`.
get the versions of server.pl on git.cacert.org, the real production .. note::
signer and the cacert-devel repository synchronized
- :file:`usbclient.pl` obsoleted USB version of The :file:`server.pl` used on test.cacert.org is different from the
:ref:`client.pl <commmodule-client-pl>` above version in the cacert-devel repository. The git origin is recorded as
`git://git-cacert.it-sls.de/cacert-devel.git` and there are some small
uncommitted changes too.
.. todo:: remove unused file (usbclient.pl) .. todo::
get the versions of :file:`server.pl` on git.cacert.org, the real
production signer and the cacert-devel repository synchronized
.. sourcefile:: CommModule/usbclient.pl
:file:`usbclient.pl` is an obsoleted USB version of
:sourcefile:`client.pl <CommModule/client.pl>` above
.. todo:: remove unused file (usbclient.pl)
.. index:: includes .. index:: includes
.. index:: PHP .. index:: PHP
Directory :file:`includes` Directory :file:`includes`
============================== ==========================
.. _includes-.cvsignore: .. sourcefile:: includes/.cvsignore
.. sourcefile: includes/.cvsignore :file:`.cvsignore` includes the parameters for CVS, which files to ignore by
versioning
- :file:`.cvsignore` includes the parameters for CVS, which files to ignore by versioning .. note:: CVS is long dead, is this still used?
.. _includes-.directory: .. sourcefile:: includes/.gitignore
.. sourcefile: includes/.gitignore :file:`.gitignore` contains file patterns to be ignored by Git.
- :file:`.gitignore` includes the parameters for GIT, which files to ignore by versioning .. sourcefile:: includes/about_menu.php
:links:
http://blog.cacert.org/
http://wiki.CAcert.org/
www/policy/
//wiki.cacert.org/FAQ/Privileges
www/index.php?id=47
www/logos.php
www/stats.php
http://blog.CAcert.org/feed/
www/index.php?id=7
//wiki.cacert.org/Board
https://lists.cacert.org/wws
www/src-lic.php
.. _includes-about_menu.php: :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of
the CAcert-related links.
.. sourcefile: includes/about_menu.php .. sourcefile:: includes/account_stuff.php
:links: http://blog.cacert.org/
:links: http://wiki.CAcert.org/
:links: www/policy/
:links: //wiki.cacert.org/FAQ/Privileges
:links: www/index.php?id=47
:links: www/logos.php
:links: www/stats.php
:links: http://blog.CAcert.org/feed/
:links: www/index.php?id=7
:links: //wiki.cacert.org/Board
:links: https://lists.cacert.org/wws
:links: www/src-lic.php
- :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of the CAcert-related links. .. sourcefile:: includes/account.php
:uses:
includes/about_menu.php
.... showheader
.. _includes-account_stuff.php: .. sourcefile:: includes/general_stuff.php
.. sourcefile: includes/account_stuff.php .. sourcefile:: includes/general.php
- :file:`account_stuff.php` .. sourcefile:: includes/keygen.php
.. _includes-account.php: .. sourcefile:: includes/loggedin.php
.. sourcefile: includes/account.php .. sourcefile:: includes/mysql.php
:uses: includes/about_menu.php
:uses: .... showheader
- :file:`account.php` :file:`includes/mysql.php` is not contained in the :cacertgit:`cacert-devel`
repository but is used by several other files. The file is copied from
:sourcefile:`includes/mysql.php.sample` and defines the database connection
information.
.. _includes-general_stuff.php: This file is parsed directly by :sourcefile:`CommModule/client.pl`
format changes might break the CommModule code.
.. sourcefile: includes/general_stuff.php .. sourcefile:: includes/mysql.php.sample
- :file:`general_stuff.php` :file:`mysql.php.sample` is a template for the database connection handling
code that is meant to be copied to :file:`mysql.php`.
.. _includes-general.php: The template defines the MySQL connection as a session variable `mconn` and
tries to connect to that database. It also defines the session variables
`normalhostname`, `securehostname` and `tverify`.
.. sourcefile: includes/general.php The template defines a function :php:func:`sendmail` for sending mails.
- :file:`general.php` .. php:function:: sendmail($to, $subject, $message, $from, $replyto="", \
$toname="", $fromname="", $errorsto="returns@cacert.org", \
$use_utf8=true)
.. _includes-keygen.php: Send an email. The function reimplements functionality that is readily
available in PHP. The function does not properly escape headers and
sends raw SMTP commands.
.. sourcefile: includes/keygen.php :param string $to: recipient email address
:param string $subject: subject
:param string $message: email body
:param string $from: from email address
:param string $replyto: reply-to email address
:param string $fromname: unused in the code
:param string $toname: unused in the code
:param string $errorsto: email address used for Sender and Errors-To
headers
:param bool $use_utf8: decides whether the Content-Type header uses
a charset parameter of utf-8 or iso-8859-1
- :file:`keygen.php` Configuration and actual code are mixed. It would be better to have a
separate file that just includes configuration.
.. _includes-loggedin.php: .. sourcefile:: includes/notary.inc.php
.. sourcefile: includes/loggedin.php .. sourcefile:: includes/shutdown.php
- :file:`loggedin.php` .. sourcefile:: includes/sponsorinfo.php
.. _includes-mysql-php: .. sourcefile:: includes/tverify_stuff.php
.. _includes-mysql-php-sample:
- :file:`mysql.php.sample` is a template for the database connection handling
code that is meant to be copied to :file:`mysql.php`.
The template defines the MySQL connection as a session variable `mconn` and
tries to connect to that database. It also defines the session variables
`normalhostname`, `securehostname` and `tverify`.
The template defines a function :php:func:`sendmail` for sending mails.
.. php:function:: sendmail($to, $subject, $message, $from, $replyto="", \
$toname="", $fromname="", $errorsto="returns@cacert.org", \
$use_utf8=true)
Send an email. The function reimplements functionality that is readily
available in PHP. The function does not properly escape headers and
sends raw SMTP commands.
:param string $to: recipient email address
:param string $subject: subject
:param string $message: email body
:param string $from: from email address
:param string $replyto: reply-to email address
:param string $fromname: unused in the code
:param string $toname: unused in the code
:param string $errorsto: email address used for Sender and Errors-To
headers
:param bool $use_utf8: decides whether the Content-Type header uses
a charset parameter of utf-8 or iso-8859-1
Configuration and actual code are mixed. It would be better to have a
separate file that just includes configuration.
This file is parsed by :ref:`CommModule/client.pl <commmodule-client-pl>`
format changes might break the CommModule code.
.. _includes-notary.inc.php:
.. sourcefile: includes/notary.inc.php
- :file:`notary.inc.php`
.. _includes-shutdown.php:
.. sourcefile: includes/shutdown.php
- :file:`shutdown.php`
.. _includes-sponsorinfo.php:
.. sourcefile: includes/sponsorinfo.php
- :file:`sponsorinfo.php`
.. _includes-tverify_stuff.php:
.. sourcefile: includes/tverify_stuff.php
- :file:`tverify_stuff.php`
.. index:: includes/lib .. index:: includes/lib
.. index:: PHP .. index:: PHP
@ -332,150 +322,63 @@ Directory :file:`includes`
Directory :file:`includes/lib` Directory :file:`includes/lib`
============================== ==============================
.. _includes-lib-account.php: .. sourcefile:: includes/lib/account.php
.. sourcefile: includes/lib/account.php .. sourcefile:: includes/lib/check_weak_key.php
- :file:`account.php` .. sourcefile:: includes/lib/general.php
.. _includes-lib-check_weak_key.php: .. sourcefile:: includes/lib/l10n.php
.. sourcefile: includes/lib/check_weak_key.php
- :file:`check_weak_key.php`
.. _includes-lib-general.php:
.. sourcefile: includes/lib/general.php
- :file:`general.php`
.. _includes-lib-l10n.php:
.. sourcefile: includes/lib/l10n.php
- :file:`l10n.php`
.. index:: locale .. index:: locale
Directory :file:`locale` Directory :file:`locale`
======================== ========================
.. index:: C .. sourcefile:: locale/cv.c
.. _locale-cv.c: .. sourcefile:: locale/escape_special_chars.php
.. sourcefile: locale/cv.c .. sourcefile:: locale/makefile
- :file:`cv.c`
.. index:: PHP
.. _locale-escape_special_chars.php:
.. sourcefile: locale/escape_special_chars.php
- :file:`escape_special_chars.php`
.. index:: bash
.. _locale-makefile:
.. sourcefile: locale/makefile
- :file:`makefile`
.. index:: pages
Directory :file:`pages`
=======================
This directory only contains other (sub-) directorys, structured according to specific topics.
.. include:: DIR-pages.rst
.. index:: scripts .. index:: scripts
.. index:: PHP .. index:: PHP
.. index:: txt .. index:: txt
Directory :file:`scripts`
=========================
.. include:: DIR-scripts.rst
Directory :file:`stamp` Directory :file:`stamp`
======================= =======================
.. _stamp-certdet.php: .. sourcefile:: stamp/certdet.php
.. sourcefile: stamp/certdet.php .. sourcefile:: stamp/common.php
- :file:`certdet.php` .. sourcefile:: stamp/displogo.php
.. _stamp-common.php: .. sourcefile:: stamp/.htaccess
.. sourcefile: stamp/common.php .. sourcefile:: stamp/index.php
- :file:`common.php` .. sourcefile:: stamp/old_showlogo.php.broken
.. _stamp-displogo.php: .. sourcefile:: stamp/report.php
.. sourcefile: stamp/displogo.php .. sourcefile:: stamp/showlogo.php
- :file:`displogo.php` .. sourcefile:: stamp/style.css
.. _stamp-.htaccess:
.. sourcefile: stamp/.htaccess
- :file:`.htaccess`
.. _stamp-index.php:
.. sourcefile: stamp/index.php
- :file:`index.php`
.. _stamp-old_showlogo.php.broken:
.. sourcefile: stamp/old_showlogo.php.broken
- :file:`old_showlogo.php.broken`
.. _stamp-report.php:
.. sourcefile: stamp/report.php
- :file:`report.php`
.. _stamp-showlogo.php:
.. sourcefile: stamp/showlogo.php
- :file:`showlogo.php`
.. _stamp-style.css:
.. sourcefile: stamp/style.css
- :file:`style.css`
Directory :file:`stamp/images` Directory :file:`stamp/images`
============================== ==============================
.. _stamp-images-CAverify.png: .. sourcefile:: stamp/images/CAverify.png
.. sourcefile: stamp/images/CAverify.png
- :file:`CAverify.png`
Directory :file:`tmp` Directory :file:`tmp`
===================== =====================
.. _tmp-Makefile: .. sourcefile:: tmp/Makefile
.. sourcefile: tmp/Makefile
- :file:`Makefile`
.. index:: tverify .. index:: tverify
@ -483,70 +386,18 @@ Directory :file:`tmp`
Directory :file:`tverify` Directory :file:`tverify`
========================= =========================
.. _tverify-favicon.ico: .. sourcefile:: tverify/favicon.ico
.. sourcefile: tverify/favicon.ico .. sourcefile:: tverify/.htaccess
- :file:`favicon.ico` .. sourcefile:: tverify/index
.. _tverify-.htaccess: .. sourcefile:: tverify/index.php
.. sourcefile: tverify/.htaccess
- :file:`.htaccess`
.. _tverify-index:
.. sourcefile: tverify/index
- :file:`index`
.. _tverify-index.php:
.. sourcefile: tverify/index.php
- :file:`index.php`
Directory :file:`tverify/index` Directory :file:`tverify/index`
=============================== ===============================
.. _tverify-index-0.php: .. sourcefile:: tverify/index/0.php
.. sourcefile: tverify/index/0.php .. sourcefile:: tverify/index/1.php
- :file:`0.php`
.. _tverify-index-1.php:
.. sourcefile: tverify/index/1.php
- :file:`1.php`
.. index:: WWW
.. index:: PHP
Directory :file:`www`
=====================
This contains the PHP code that is the entry point to the application:
.. include:: DIR-www.rst
.. .. _www-sealgen-php:
..
.. - :file:`sealgen.php` generates a small site seal image from
.. :ref:`www/images/secured.png <www-images-secured-png>`. This could be
.. replaced with a static image if it is used at all. This is referenced
.. by :ref:`cgi-bin/siteseal.cgi <cgi-bin-siteseal-cgi>`
.. Directory :file:`www/images`
.. ============================
..
.. .. _www-images-secured-png:
..
.. - :file:`secured.png` is a small image used by
.. :ref:`www/sealgen.php <www-sealgen-php>`

View file

@ -60,7 +60,7 @@ Format of NUL requests
---------------------- ----------------------
NUL requests are sent at the end of each iteration in NUL requests are sent at the end of each iteration in
:ref:`client.pl <commmodule-client-pl>`'s main loop. :sourcefile:`client.pl <CommModule/client.pl>`'s main loop.
.. table:: NUL request header format .. table:: NUL request header format
@ -95,7 +95,7 @@ Format of X.509 signing request messages
---------------------------------------- ----------------------------------------
X.509 signing request messages are sent in X.509 signing request messages are sent in
:ref:`client.pl <commmodule-client-pl>`'s main loop for each requested :sourcefile:`client.pl <CommModule/client.pl>`'s main loop for each requested
certificate. certificate.
.. table:: X.509 certificate signing request header format .. table:: X.509 certificate signing request header format
@ -149,11 +149,11 @@ table which is one of
.. note:: .. note::
The CA root identifier is retrieved from the database by The CA root identifier is retrieved from the database by
:ref:`client.pl <commmodule-client-pl>` the value that is found there is :sourcefile:`client.pl <CommModule/client.pl>` the value that is found there is
decremented by 1 before it is sent to the server. decremented by 1 before it is sent to the server.
The server in :ref:`server.pl <commmodule-server-pl>` restricts the allowed The server in :sourcefile:`server.pl <CommModule/server.pl>` restricts the
root id in its ``CheckSystem`` function. allowed root id in its ``CheckSystem`` function.
.. _table-cert-profiles: .. _table-cert-profiles:
@ -178,7 +178,7 @@ table which is one of
.. note:: .. note::
:ref:`client.pl <commmodule-client-pl>` supports profiles 0, 1, 2, 4, :sourcefile:`client.pl <CommModule/client.pl>` supports profiles 0, 1, 2, 4,
5, 6, 8 and 9 only. 5, 6, 8 and 9 only.
.. _table-md-ids: .. _table-md-ids:
@ -202,7 +202,7 @@ Format of OpenPGP key signing request messages
---------------------------------------------- ----------------------------------------------
OpenPGP key signing request messages are sent in OpenPGP key signing request messages are sent in
:ref:`client.pl <commmodule-client-pl>`'s main loop for each requested :sourcefile:`client.pl <CommModule/client.pl>`'s main loop for each requested
OpenPGP key. OpenPGP key.
.. table:: OpenPGP key signing request header format .. table:: OpenPGP key signing request header format
@ -227,7 +227,7 @@ OpenPGP key.
- "" - ""
.. [#unused-server] the field is unused in .. [#unused-server] the field is unused in
:ref:`server.pl <commmodule-server-pl>` :sourcefile:`server.pl <CommModule/server.pl>`
.. _signer-csr-request-format: .. _signer-csr-request-format:
@ -235,7 +235,7 @@ Format of X.509 certificate revocation request messages
------------------------------------------------------- -------------------------------------------------------
X.509 certificate revocation request messages are sent in X.509 certificate revocation request messages are sent in
:ref:`client.pl <commmodule-client-pl>`'s main loop for each requested :sourcefile:`client.pl <Commmodule/client.pl>`'s main loop for each requested
X.509 certificate revocation. X.509 certificate revocation.
==== =========================== ==== ===========================