Subsections

1.7 Configuration Of OPT_VOUCHER

OPT_C3SURF_VOUCHER

OPT_C3SURF_VOUCHER='no'

Activate the voucher system of opt C3SURF_VOUCHER ('yes'), default is 'no'. Vouchers are anonymous yet secure single-use accounts that can be used for login. Requirement is the setting OPT_LOGINUSR='yes'.

The creation and deletion of the vouchers is done by two nightly cron jobs which also can be started manually at any time (admin interface). The following explains how to manage these jobs.

All newly generated vouchers are attached to a print list. Only in the print list the password corresponding to the voucher is stored in plain text. You can download, print or delete this list at any time. After deleting the list, the password can not be recovered again. Normally the list is printed first and then deleted. There should only exist one printed copy of a voucher. the print function is implemented in html, page feeds are not taken into account. Vouchers which are not printed caused by a page feed should be destroyed (though they get invalid due to expiration anyway). Lists that were not printed but downloaded may get an own layout with other programs which also avoids the page feed caveat.

C3SURF_VOUCHER_N

C3SURF_VOUCHER_N='n'

Value range: 0 and natural numbers

How many different voucher categories should be produced? The most important criterion for vouchers is the runtime. Next to it are the number of vouchers and their validity in days. See also the following variables.

C3SURF_VOUCHER_x_TIME

C3SURF_VOUCHER_x_TIME='30'

Value range: natural numbers

Duration in minutes (here: 30) for a voucher of this category ('n' see above).

C3SURF_VOUCHER_x_COUNT

C3SURF_VOUCHER_x_COUNT='3'

Value range: natural numbers

How many vouchers of this category (in this case 3) should be produced?

C3SURF_VOUCHER_x_DAYS

C3SURF_VOUCHER_x_DAYS='90'

Value range: 0 and natural numbers

How many days do you want the voucher to be valid starting from its generation (here: 90). Thus, an expiration date for this coupon is generated. The deletion is then carried out either manually or via cron job. The voucher is void when it is first used.


Important: '0' means that vouchers of this category have no expiration date. They only become invalid with use or if the time has been completely consumed (also affected by C3SURF_VOUCHER_LIVES_N). However they may be deleted at any time in the admin interface.

1.7.1 Optional Parameters Of OPT_VOUCHER

C3SURF_VOUCHER_x_LIVES

C3SURF_VOUCHER_x_LIVES='n'

Value range(s): -1, 0, natural numbers

Number of hours, in which the voucher is still valid after your first login.


Special cases:

These vouchers will not become invalid with the first login, but are valid for 'n' more hours. Once the voucher is used, a time-limited LOGINUSR account is generated or the expiry date of the voucher is recalculated. This account / voucher may login and logout for any number of times. The quota system of LOGIN_USR is used for this account. If the total time or the expiry date (C3SURF_VOUCHER_DAYS_N) is reached, C3SURF will automatically delete this account.

C3SURF_VOUCHER_DEL_CRON

C3SURF_VOUCHER_DEL_CRON='0 4 * * *'

Value range: 'cron-Syntax' or 'never'

The above value is the default if the variable is missing in the config file 'c3surf.txt'. Default: delete all expired vouchers every morning at 4 o'clock.

Cron syntax must be obeyed and will not be verified. The value 'never' may be used in addition. Then the job is not scheduled by the system. In the admin interface all expired vouchers may be deleted manually at any time.

C3SURF_VOUCHER_GEN_CRON

C3SURF_VOUCHER_GEN_CRON='15 4 * * *'

Value range: 'cron-Syntax' or 'never'

The above value is the default if the variable is missing in the config file 'c3surf.txt'. Default: generate new vouchers daily at 4:15 AM if less than
C3SURF_VOUCHER_COUNT exist.

Cron syntax must be obeyed and will not be verified. The value 'never' may be used in addition. Then the job is not scheduled by the system. In the admin interface new vouchers may be generated manually at any time, up to the amount defined in C3SURF_VOUCHER_x_COUNT.

All newly generated vouchers are attached to a print list. Only in the print list the password corresponding to the voucher is stored in plain text. Each voucher should be printed only once. The list should be deleted immediately after printing or downloading.

C3SURF_VOUCHER_PRTUPDATE

Default Setting: C3SURF_VOUCHER_PRTUPDATE='no'

Value range: 'yes' or 'no'

Update of the print file. My recommendation: 'no'. If only a few vouchers are held in the system and the print file should not be deleted after printing or downloading, an update of the print file can be specified with 'yes' when vouchers are used. In the case of 'yes' used vouchers are also deleted from the print file. This requires resources on the router.

C3SURF_VOUCHER_USRLEN

Default Setting: C3SURF_VOUCHER_USRLEN='12'

Value range: '1-16'

Set character length for voucher account, from 8 characters on '-' will be filled in as separators, which also must also be entered. There are always four characters grouped. The maximum value is 16.

C3SURF_VOUCHER_USRCAP

Default Setting: C3SURF_VOUCHER_USRCAP='random'

- 'yes' : only capital letters
- 'no' : all lowercase
- 'random' : random change of upper and lower case (recommended)

This variable determines whether uppercase or lowercase letters should be used in the user name. The value 'random' (recommended) causes a random selection.

C3SURF_VOUCHER_PWDLEN

Default Setting: C3SURF_VOUCHER_PWDLEN='6'

Value range: 1-12

Character length for the voucher password.

C3SURF_VOUCHER_PWDMOD

Default Setting: C3SURF_VOUCHER_PWDMOD='3'

Value range: 1-5

Modulo for random extensions of the password. Max: 5 (the values 0, 1, 2, 3, 4), Min 1 (the value 0). It is used randomly in the password generation to change the possible values. This results by default in password lengths from 6 to 8 characters. The maximum are password-lengths between 12 and 16 characters, in conjunction with random upper- and lowercase letters this is considered as safe.

C3SURF_VOUCHER_PWDCAP

Default Setting: C3SURF_VOUCHER_PWDCAP='random'

- 'yes' : only capital letters
- 'no' : all lowercase
- 'random' : random change of upper and lower case (recommended)

This variable determines whether uppercase or lowercase letters should be used in the password. The value 'random' (recommended) causes a random selection.

© 2001-2015 The fli4l-Team - 26 July 2015