Simple Auth for Control System Studio

Table of Content

About CSS Simple Auth

The Simple Authentication and Authorization Support for Control System Studio is a set of two plugins for CSS. One of the plugins provides a simple login module, reading valid username/password combinations from the preferences. The other plugin provides an authority, that reads the rights assigned to specific users from its preferences. Together, both provide a simple way of assigning rights to users in an environment, where security is not a main goal and logins are only used for avoiding accidental actions.

How to Use

In order to use the simple authentication and authorization plugins, you have to download the two JAR files and place them in the plugins directory of your CSS installation.

You can configure the plugin by placing properties in your plugin_customization.ini file:

#
# Configuring users and their passwords
#
com.aquenos.csstudio.platform.simple.login/users.someuser.password=hackme
com.aquenos.csstudio.platform.simple.login/users.anotheruser.password=changeme
com.aquenos.csstudio.platform.simple.login/users.thirduser.password=changeme

#
# Assigning roles to users
#
com.aquenos.csstudio.platform.simple.authorization/users.anotheruser.roles=admin
# You can assign multiple roles to a user
com.aquenos.csstudio.platform.simple.authorization/users.thirduser.roles=config,operator
# You can use the special username "*" to assign one or more roles to all users
com.aquenos.csstudio.platform.simple.authorization/users.*.roles=everyone

#
# Assigning privileges (actions) to roles
#
com.aquenos.csstudio.platform.simple.authorization/roles.everyone.actions=alarm_ack
com.aquenos.csstudio.platform.simple.authorization/roles.config.actions=alarm_config
# You can use the special action name "*" to assign a role the
# privilege to perform any action.
com.aquenos.csstudio.platform.simple.authorization/roles.admin.actions=*

In the EPICS release of Control System Studio version 3.0.2 (released by SNS) there is a bug, which will cause any login to fail without even displaying the login dialog.

For fixing this bug, you have to replace the org.csstudio.basic.epics.product plugin with a newer version. For your convenience you can download a packaged version of a snapshot from the Mercurial repository here.

When replacing the bundled version of the plugin, you will most likely have to adjust the corresponding line in configuration/org.eclipse.equinox.simpleconfigurator/bundles.info to match the new version.

Download

This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0. By downloading the software you agree to be bound the the terms of this license. In particular, you have to agree to sections five (“NO WARRANTY”) and six (“DISCLAIMER OF LIABILITY”) before downloading the software.

Release 1.0.0 (January 21st, 2012):
Changes:
First release of the simple auth plugins.

Contact

You can contact the author of this software, Sebastian Marsching, at css-simple-auth-maintainer removethis <at> oss <dot> aquenos <dot> com.

Visit other projects on oss.aquenos.com.

© 2012 aquenos GmbH