Server security - whitelist file

To control other users’ access rights to your ecFlow server you can define a white list file.

The default name of the file is ecf.lists hence the server will by default look for <host>.<port>.ecf.lists.

The ECFLOW white list file is a way of restricting the access to ecFlow to only known users. The file lists users with full access and users with only read access. Including a user name gives full read/write access, starting with ‘-’ (dash/minus) gives read access only. Note you must include a version number, e.g. 4.4.14 as the first non-comment line to allow for potential future updates to the format. The environment variable ECF_LISTS is used to define the white list file name which should exist in the ECF_HOME folder of your server. The white list file is an ASCII file.

Note

When creating a white list file (ecf.lists) be sure to include your user name with read/write privileges. Otherwise, you can be locked out of your own server.

File ecf.lists:

Listing 62 Named users with write and read access
4.4.14 # whitelist version number
#Maintenance group and operators
#users with read/write access
myuid
uid1
uid2
#
#Read-only users
#
-uid3
-uid4

For more information see ecFlow White list file and reloadwsfile.

What to do

  1. The expected name of the whitelist file for your server is available from the ECFLOW variable ECF_LISTS. Check this.

  2. In the home directory of your ecFlow server create a file given by ECF_LISTS containing your user id with read/write access.

  3. Load the white list file onto your server using the client command:

    ecflow_client --reloadwsfile