katringoogoo/sramsync

Python utility for reading from an SRAM LDAP. The data read can be processed in any feasible manner as long as there is an implementation class. This class is loaded dynamically.

SRAMsync

Purpose of SRAMsync

SRAMsync is an LDAP synchronization script written in Python. Originally it was developed for synchronization between SRAM and an LDAP at SURF, such that different SURF Research services would be able to obtain user attributes and grant users access to the services. The first versions were tailored towards the specifics needed by SURF, version 2 takes things a little further and generalizes a few pieces a bit more such that its applicability is extended.

Installation

The SRAMsync package can be installed by pip. Use the following the install the latest from the main branch on GitHub:

pip install git+https://github.com/SURFscz/SRAMsync.git#egg=SRAMsync

If you wish to use a specific version you should use the following:

pip install git+https://github.com/SURFscz/[email protected]#egg=SRAMsync

The exact versions, i.e. the @v3.0.0 in the above url, can be found the tags page at GitHub.

Invocation

The SRAMsync package contains an executable called: sync-with-sram. It takes a single argument and options. This argument is a YAML configuration file that tells where to find the LDAP to sync from, baseDN, bindDN and password. The configuration file also tell what groups need to be synced and what they will be called in the destination LDAP.

Structure of sync-with-sram

The sync-with-sram consists out of a main loop that iterates over the SRAM LDAP as defined per configuration. The main loop does not do anything more than this iteration. For example, it does not write entries into a destination LDAP. In fact, the main loop in unaware what it should do with all encountered entries. All it does is emitting events when some action could be required. Events are triggered when for example the main loop detects that a new user is added to SRAM. Now it is up to whoever is responsible for dealing with such an event and what it really means. In case of a new user this should ultimately end with a user being added to some destination LDAP, but it is not the responsibility of the main loop. Instead the configuration requires an EventHandler class to be instantiated that takes care of this functionality.

A design choice was to dynamically load derived EventHandler classes. Thereby allowing for multiple implementations of emitted events. This allows for flexibility such that sync-with-sram can be invoked for any number of environments which need to synchronize SRAM LDAP attributes. Although, sync-with-sram started out as an LDAP to LDAP synchronization process, given its design the destination end does not need to be an LDAP. It is up to an EventHandler class to decide what needs to be done.

Events

SRAMsync defines the following events and their variables:

• start-co-processing: co
• add-new-user: co, group, givenname, sn, user, mail
• add-public-ssh_key: co, user, key
• delete-public-ssh-key: co, user, key
• add-new-group: co, group, attributes
• remove-group: co, group, attributes
• add-user-to-group: co, group, user, attributes
• remove-user-from_group: co, group, user, attributes
• remove-graced-user-from-group: co, group, user, attributes
• finalize

In fact, the above defined events are from the abstract base class found in the EventHandler class. In case you wish to create your own EventHandler, you should derive such class from the EventHandler abstract base class.

When are events emitted

Event are emitted from the main loop of sync-with-sram. Some event are always emitted at the appropriate moment like: start-co-processing and finalize. The emitting of other events depends on the current state of SRAM LDAP and the destination. If there are no differences not events will be emitted.

start-co-processing

Input	Description
co	CO name for which the synchronization has started.

Emitted at the beginning and before any other event. This is to signal that the synchronization process has started for CO co and is always emitted.

add-new-user

Input	Description
co	CO name for which the event was emitted.
group	Group to which the user needs to be added.
givenname	First name of the user as it is known to SRAM.
sn	Last name of the user as it is known to SRAM.
user	User name of the user at the destination.
mail	E-mail address of the user as it is known to SRAM.

When a new user is detected in the SRAM LDAP, this event will be emitted for each new users that is part of a login_group or the @all reserved group which holds all CO members by default. See group for more details on login_group and how to define one.

add-public-ssh-key

Input	Description
co	CO name for which the event was emitted.
user	User name as it is used on the destination.
key	Public SSH key of the user.

When a user adds a new public SSH key to its profile in SRAM, this event will be emitted. Note that an update of an SSH key will not be detected as a change, but rather as removal of an old key and adding a new key instead.

delete-public-ssh-key

Input	Description
co	CO name for which the event was emitted.
user	User name as it is used on the destination.
key	Public SSH key of the user

When a users deletes a public SSH key in its profile in SRAM, this event will be emitted. Note that an update of an SSH key will not be detected as a change, but rather as removal of an old key and adding a new key instead.

add-new-group

Input	Description
co	CO name for which the event was emitted.
group	Name of the group that exists in SRAM but not yet at the destination.
attributes	List of attributes as specified for the group in the sync-with-sram configuration file.

When a new group appears in the SRAM LDAP for for the current CO, this event will be emitted. The attributes from the configuration file are send along for possible further processing.

remove-group

Input	Description
co	CO name for which the event was emitted.
group	Name of the group that exists in SRAM but not yet at the destination.
attributes	List of attributes as specified for the group in the sync-with-sram configuration file.

When a group is removed in the SRAM LDAP for for the current CO, this event will be emitted. The attributes from the configuration file are send along for possible further processing.

add-user-to-group

Input	Description
co	CO name for which the event was emitted.
group	Name of the group that exists in SRAM but not yet at the destination.
user	User name of the user at the destination.
attributes	List of attributes as specified for the group in the sync-with-sram configuration file.

When in SRAM a user is added to a group, this event will be emitted. This is different from the add_new_user event as that one is emitted for login_groups and this one for all other groups. In other words, the user is already provisioned at the destination, but not yet added to the group.

remove-user-from-group

Input	Description
co	CO name for which the event was emitted.
group	Name of the group that exists in SRAM but not yet at the destination.
user	User name of the user at the destination.
attributes	List of attributes as specified for the group in the sync-with-sram configuration file.

When a user is removed from a group, this event will be emitted. However, if the group has the grace_period attribute set, the user will not be removed until the grace period has ended. This event will be emitted non the less that the user has been removed from the group.

remove-graced-user-from-group

Input	Description
co	CO name for which the event was emitted.
group	Name of the group that exists in SRAM but not yet at the destination.
user	User name of the user at the destination.
attributes	List of attributes as specified for the group in the sync-with-sram configuration file.

When a user has been removed from a group, for which the grace_period attribute was set, and the grace period of the user has passed, this event will be emitted. This also means that sync-with-sram will remove this user from the group defiantly.

finalize

Input: none

This is the very last event to be emitted. It signals that the synchronization has finished and is always emitted

Configuration details

The executable sync-with-sram needs a configuration file in order to know what and how to sync. The configuration is done in YAML. At the highest level the configuration looks as follows:

service: <service name>
secrets:
  file: <path to secrets file>
sram:
   <connection details>
sync:
   <synchronization details>
status_filename: <file name>
provisional_status_filename: <file name>

As can be noticed from the above, two major blocks can be identified.

1. sram: Connection details for SRAM
2. sync: What and how to synchronize

The service key is for specifying the name of the local service. Both status_filename and provisional_status_filename are file names where sync-with-sram keeps track of the current state. The status_filename is read at the beginning so that sync-with-sram can determine the state of the last sync. provisional_status_filename is optional. If you do use it, sync-with-sram will write its status info to that file instead and not status_filename. It is expected that the instantiated EventHandler object copies the provisional_status_filename to status_filename. If the instantiated object fails to do so, sync-with-sram will always see new event as the status_filename is never updated to the latest sync state.

The secrets part is optional. However, if omitted, one does need to put any passwords in the configurations file itself, or use the appropriate environment variable. This, however, is only possible for the SRAM LDAP password. If you also need a password for for example an SMTP connection, this password must be put into the configuration file in plain text.

SRAM connection details

The script needs to know how it should connect to the SRAM LDAP. As a service you are allowed to read, not write, to a subtree in LDAP that has been created for your service. You should have been given a base DN and accompanying bind DN and passwd. The full specification of the sram: key is as follows:

sram:
  uri: ldaps://ldap.sram.surf.nl
  basedn: dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  binddn: cn=admin,dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  passwd: <your password>

or,

sram:
  uri: ldaps://ldap.sram.surf.nl
  basedn: dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  binddn: cn=admin,dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  passwd_from_secrets: true or false

Please note that for the latter, you must include the secrets section as well. See next section.

Password file format

The password file can contain passwords for multiple sources. The file name is configured in the secrets block. Currently only loading passwords from file is supported. The secrets block is defines as follows:

secrets:
  file: <file name>

When the above is specified in the configuration file, the secrets in it will be loaded regardless of being used in the configuration file. One could have the secrets being loaded and still use plain text passwords for for example the SRAM LDAP. Currently it can hold passwords for both the SRAM LDAP and for SMTP connections. Each source has its own part in the password file. All SRAM LDAP related passwords for example are grouped under sram-ldap, while the SMTP passwords are bundled under smtp. Below is an example of a password file.

{
  "sram-ldap": {
    "my_service_A": "fh9dFDSf67fsd;fdsgh",
    "my_service_B": "uirweSD_3$Afdhs!^Z1"
  },
  "smtp": {
    "<smtp host name>": {
      "<smtp login>": "fsdf,mm$$fgsff"
    }
  }
}

If you do use the EmailNotifications class for sending notification by e-mail, you don't have to have the smtp block in your password file.

SRAM LDAP passwords

The passwords for the SRAM LDAP are listed as key value pairs. The key is the name of the service, i.e. the service part in a sync-with-sram configuration and the value is the password for the SRAM LDAP subtree.

SMTP password

The SMTP passwords take a slightly more complex structure then the key value pairs of SRAM LDAP passwords. For SMTP you need the FQDN (without the dot at the very end) of the SMTP host and the login account name. Login account names and the associated password form a key value pair and are grouped under the SMTP FQDN

Environment variable

One could also use an environment variable (SRAM_LDAP_PASSWD) containing the SRAM LDAP password. If it is specified it take precedence over either passwd or passwd_file. If neither passwd nor passwd_file is specified in the configuration, the environment variable must be present. If not an error is shown.

Synchronization details

The sync: holds all information regarding what to sync and in which way to do it. Within this key there are three blocks: groups:, event_handler: and grace:. Thus on a high level, the sync: block look like this:

sync:
  groups:
    <group synchronization information>
  event_handler:
    name: <SRAMsync event handler class name to instantiate>
    config:
      <configuration belonging to the instantiated EventHandler class>
  grace:
    <group names for which to apply a grace period>:
      grace_period: <grace period in days>

groups

The group block specifies what groups need to be synced from SRAM. You must use the short names for groups in SRAM as this is how SRAM CO groups appear in the SRAM LDAP. This does not mean that they must appear with the same name in the destination LDAP. In order to specify its destination name, you must use the destination: key.

The EventHandler might need some additional information. These are called attributes in the configuration and are a list (array) of strings to be passed along to the EventHandler instantiation. The values of these strings are meant to be interpreted by the instantiated class and are meaningless to the main loop.

Lets assume the short name of the CO group to be synchronized is: 'experiment_A' and that we would like to call it 'sram_experiment_a' at the destination. The specification for a group is as follows:

sync:
  groups:
    expermiment_A:
       attributes: ["attibute_1", "attibute_2", "attibute_3"]
       destination: sram_experiment_a

The number of groups is unlimited.

Exceptions to the rule

The previous sub section stated that the attributes are meaningless to the main loop. There are, however, two exceptions: login_users and grace_period. All users within a CO are also available in the @all entry. A service might wish for a more fine grained control on what users are allowed access. For this purpose a group can be marked login_users through the attributes. This tells sync-with-sram that it should not use the @all group, but rather the group with this attribute. This means that sync-with-sram will only use this group for adding users. In case there is not group with such an attribute, the main loop will you the @all instead.

The grace_period attribute tells sync-with-sram for this particular group a grace period must be applied. See also grace section below.

event_handler

The event_handler: key understands two keys: name: and config:. The name: key specifies the class name of which an instance must be created at run time, while the config: key specifies a YAML configuration that needs to be passed on to the instantiation class. The main loop is unconcerned with this configuration and ignores its structure. The instantiated class however could check for its validity. The specification for event_handler is as follows:

sync:
  event_handler:
    name: <class name>
    config:
       ...
       ...

The config: in the above is optional.

grace

The grace key is used when the removal of users should not take place immediately, but should be effectuated after a grace period. Normally sync-with-sram would emit a removal event when it detects that a user is no-longer present in a group. This would then trigger an immediate removal of that users. The grace key allows for a delay by specifying for which groups a grace period exists and the length of this period.

The grace key lists the short names for groups in SRAM for which you want to use a grace period and then you specify the period in the number of days. The specification for grace is as follows:

sync:
  grace:
    expermiment_A:
      grace_period: 90

The grace: key is not mandatory, but must be used when at least one group has the grace_period attribute.

Putting it together

In order to get a valid configuration, we need to put together all the needed elements. Thus a valid configuration should look like this:

service: my_service
secrets:
  file: <path to secrets file>
sram:
  uri: ldaps://ldap.sram.surf.nl
  basedn: dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  binddn: cn=admin,dc=<service short name>,dc=services,dc=sram,dc=surf,dc=nl
  passwd_from_secrets: true
sync:
  groups:
    expermiment_A:
       attributes: ["attibute_1", "attibute_2", "attibute_3"]
       destination: sram_experiment_a
    expermiment_B:
       attributes: ["attibute_4"]
       destination: sram_experiment_b
  event_handler:
    name: DummyEventHandler
  grace:
    expermiment_A:
      grace_period: 90
status_filename: status.json
provisional_status_filename: provisional-status.json

In the above we see that two groups are synchronized: expermiment_A and expermiment_B. A DummyEventHandler class is used to deal the emitted events from the main loop. In case of the DummyEventHandler nothing is done except printing debug messages to stdout. It does not take any additional configuration and therefor the config: key is omitted.

Note that in the above sram block,

passwd_from_secrets: true

can be substituted by:

passwd: <password>

Also note the even though either keyword passwd_from_secrets or passwd can be specified, if the environment variable SRAM_LDAP_PASSWD is defined, it takes precedence over either key word.

Tag substitution

The configuration has support for tag substitution. This means that certain keywords between curly brackets are substituted by their value. For example, the configuration allows for defining the service name with the service: key. When defining destination names for groups, the {service} tag can be used and is replaced by the key value at run time. Given the following configuration snippet:

service: compute
sync:
  groups:
    login_users:
      destination: "{service}-login_users"

The {service} tag is replace by compute and the following snippet is equal to the previous one:

service: compute
sync:
  groups:
    login_users:
      destination: "compute-login_users"

In case you need to sync multiple services, you could also use the {service} tag for the status_filename and provisional_status_filename to easily distinguish status files for different services.

Available tags

The following tags are available:

Config Item	Tags
status_filename	{service}
provisional_status_filename	{service}
mail_subject	{service}
mail_message	{service}
sync/users/rename_user	{co}, {uid}
sync/groups/<group>/destination	{service}, {org}, {co}

Removal of the status file

When the status file is removed, it effectively means that all SRAM LDAP entries appear as new and thus each entry will be up for synchronization. Weather this is a problem or not depends on the EventHandler. In case of the CuaScriptGenerator it is not and removing of the status file can be done safely.

Logging

SRAMsync supports different log levels: CRITICAL, ERROR, WARNING, INFO and DEBUG. The default level is set to ERROR and can be changed by the --loglevel \<level> option or its short hand equivalent -l. One could also switch on debug logging quickly, by selecting either --debug or -d. The --verbose option increase the log level once each time selected and can be used multiple times.

EventHandler Classes

A few EventHandler classes are available. Each has its own configuration and can be selected in the configuration file by simply specifying the name of the EventHandler in the name property.

For creating your own custom EventHandler implementation see below.

DummyEventandler

This the most basic implementation of an EventHandler class. All is does is print an informative message, which shows up when the loglevel is set to DEBUG.

A configuration could be passed at creation time and it will be printed out for the DEBUG level.

CuaScriptGenerator

The purpose of the CuaScriptGenerator is for the SURF LDAP, called CUA. In order to interact with the CUA, a set of command line tools have been developed over the years. These are known as sara_usertools. Two commands are provided: sara_adduser and sara_modifyuser. These commands do the heavy lifting one normally needs to do with ldapsearch, ldapadd and ldapmodify commands. By providing these tools the CUA is shielded by incorrect usages of the low level LDAP commands.

The CuaScriptGenerator generates a bash script composed of sara_usertools commands. Execution of the generated bash script brings the CUA in line with SRAM. Since sync-with-sram cannot learn what the current state of the CUA is, a status file is generated upon each synchronization run. Theoretically the execution of the generated bash might fail at any point and the status of the CUA might be in some state between the original state at the beginning of the synchronization and the desired end goal. In order to guard against this situation, the status file is not created immediately. Instead a provisional status file is generated. It is up to the generated bash script to update the status file with the provisional one once all bash script reaches the end of its execution.

If the status file is not replaced by the provisional one, SRAMsync will generate the same bash script again. Thus a replay of already executed commands cannot be avoided. It is thus replied upon that the sara_usertools is robust against these kinds of replays.

The CuaScriptGenerator makes use of any additional EventHandler class. This could be for example the EmailNotifications class for mailing events.

Configuration

The CuaScriptGenerator class needs to know a few things in order to be able to generate a bash script based on the sara_usertools. First of all, there is the name of the generated script. This is specified by: filename:. Then there are the three commands for adding, modifying and checking groups and users: add_cmd:, modify_cmd:, check_cmd and sshkey_cmd. All commands can be prefixed with sudo and can be extended with options, e.g. sudo sara_adduser --no-usermail. This string will be inserted literally into the bash script when sara_adduser is needed. The check_cmd is used prior to adding users or groups to determine if the user or group already exists. Adding and removing public SSH keys is done through the sshkey_cmd.

The final key that the CuaScriptGenerator understands, but does not require, is auxiliary_event_handler: Any EventHandler class can be given here. If specified, the CuaScriptGenerator will as part of its own processing of the emitted events, call for the same events of the auxiliary_event_handler. This way it is for example possible to not only generate a bash script but also mail notifications as they happen.

The following is the configuration for the CuaScriptGenerator class:

sync:
  event_handler:
  name: CuaScriptGenerator
  config:
    filename: <filename>
    add_cmd: sudo sara_adduser --no-usermail
    modify_cmd: sudo sara_modifyuser --no-usermail
    check_cmd: sudo sara_modifyuser --no-usermail --check
    sshkey_cmd: sudo sara_modifyuser --no-usermail --ssh-public-key
    auxiliary_event_handler:
      name: EmailNotifications
      config:
        <EmailNotifications configuration>

CbaScriptGenerator

The CbaScriptGenerator is tightly coupled to the CuaScriptGenerator class. Therefore the CbaScriptGenerator cannot be used independently from the CuaScriptGenerator. This means that if you use this class, you will need to provide a configuration for the CuaScriptGenerator class as well.

The purpose of the CbaScriptGenerator class is to enhance the generated bash script of the CuaScriptGenerator class. When a user gets added and CBS accounting is need, this class inject the appropriate command for this. The same holds true for removing a user. The resulting bash script needs to executing in order for the generated command to take affect.

Configuration

The CbaScriptGenerator class introduced the following configuration:

sync:
  event_handler:
    name: CbaScriptGenerator
    config:
      cba_add_cmd: <CBA command for adding a user>
      cba_del_cmd: <CBA command for deleting a user>
      cba_machine: <CBA machine name>
      cba_budget_account: <CBA budget account>
      cua_config:
        ...

When using the CbaScriptGenerator class, four required configuration fields must be present: cba_add_cmd, cba_del_cmd, cba_machine and cba_budget_account. The fifth, cua_config is also required and marks the start of the CUA configuration. Please refer to CuaScriptGenerator for additional information on the CuaScriptGenerator class and how it is configured. Note that the what follows the config CuaScriptGenerator class should follow the cua_config for the CbaScriptGenerator configuration.

EmailNotifications

If you want to be informed by email about any of the emitted events during the execution of the main loop, the EmailNotifications class does that. It connects to an SMTP server and sends customizable email through it. Events are conveniently grouped so you don't receive a separate email for each emitted event. That would add up real quickly. Instead all events for a CO are collected first and once the main loop has finished processing the CO, all queued messages are collected in a single email. In the configuration of the EmailNotifications class you can specify for which events you would like to be notified. For each notification you can configure the line that needs to be generated and optionally a header that is used for that event. In other words, each event takes the form of:

<event>:
  header: <header line>
  line: <event line>

In order to connect to an SMTP server, the following configuration keys are available:

smtp:
  host: <SMTP host>
  port: <SMTP port number>
  login: <SMTP login name>
  passwd: <SMTP password>

For composing email messages, the configuration supports the following keys:

  mail-to: <mail recipiant>
  mail-from: <who is sending the email>
  mail-subject: <mail subject>
  mail-message: <mail message body>

The mail-message: should contain at a minimum the following text {message}, if you want the headers and lines from the event to appear in mail. This tag is replaced by the headers and lines of the events.

Configuration

sync:
  event_handler:
  name: EmailNotifications
  config:
    aggregate_mails: <boolean>
    report_events:
      start-co-processing:
        header: <start header>
        line: <start line>
      add-new-user:
        header: <add-new-user header>
        line: <add-new-user line>
      add-ssh-key:
        header: <add-ssh-key header>
        line: <add-ssh-key line>
      delete-ssh-key:
        header: <delete-ssh-key header>
        line: <delete-ssh-key line>
      add-group:
        header: <add-group header>
        line: <add-group line>
      remove-group:
        header: <remove-group header>
        line: <remove-group line>
      add-user-to-group:
        header: <add-user-to-group header>
        line: <add-user-to-group line>
      remove-user-from-group:
        header: <remove-user-from-group header>
        line: <remove-user-from-group line>
      remove-graced-user-from-group:
        header: <remove-graced-user-from-group header>
        line: <remove-graced-user-from-group line>
      finalize:
        header: <finalize header>
        line: <finalize line>
      smtp:
        host: <SMTP host>
        port: <SMTP port number>
        login: <SMTP login name>
        passwd: <SMTP password>
      mail-to: <mail recipiant>
      mail-from: <who is sending the email>
      mail-subject: <mail subject>
      mail-message: <mail message body>

For available tags in formatting headers and lines, please also refer to Tag substitution and Events. The italic keywords in the Event section are available as tags for both header: and line: keys.

event_handler:
  name: EmailNotifications
    config:
      report_events:
        add-new-user:
          header: "Adding the following users:"
          line: "Add new user {user}"

The aggregate_mails is optional and when left out defaults to true, in which case a single mail will be send for the enitre synchrnonization run. In this e-mail all events are grouped per CO. If aggregate_mails is set to false, a mail for each CO is generated. If there are no important events to be reported, i.e. events other that start-co-processing and finalize the e-mail sending is repressed.

SMTP passwords

The above example shows plain text passwords in the configuration file. Instead of using the passwd in the smtp block, one could also use passwd_from_secrets. This only works if you have opted to use the secrets block in the configuration. See Password file format for more information.

Creating a custom EventHandler

Alternatively one can also specify their own EventHandler class by setting the name property to the exact package & module name of the class.

Assume we have the following EventHandler in the file my_event_handler.py in the folder my_package:

from SRAMsync.event_handler import EventHandler

class MyEventHandler(EventHandler):
  <implementation of all abstract methods>

Then the event_handler property needs to be set to

sync:
  <other sync parameters ...>
  event_handler:
    name: my_package.my_event_handler.MyEventHandler
    config:
      <MyEventHandlerConfig (optional)>

The sources only need to be visible via PYTHONPATH:

export PYTHONPATH=/path/to/source/:$PYTHONPATH
sync-with-sram -d path/to/config.yaml