Product Documentation

This document is a configuration guide for RCDevs WebADM. The reader should notice that this document is not a guide for configuring WebADM applications (Web Services and WebApps).
Specific application guides are available through the RCDevs online documentation library.
WebADM installation and setup is not covered by this guide and is documented in the WebADM Installation Guide

Product Overview

WebADM is a powerful Web-based LDAP administration software designed for professionals to manage LDAP Organization resources such as domain users and groups. It is also the configuration interface for RCDevs Web Services and WebApps (end-user applications).

WebADM usage is 100% graphical and many features are documented inside the management interface itself. Moreover, WebADM has been built for a maximum ease of use and its usage is very intuitive. For this reason, not all the features are documented in this guide as they are most of the time self-explanatory.

WebADM can be used standalone, as a powerful LDAP management interface. It provides a hierarchical view of LDAP Organizations, SQL and file-based audit trails and ultra-rich LDAP object management features. It is the centralized administration interface for all RCDevs Web services and Web applications. It supports domains of users, LDAP groups, multi-level applications' policies, web service client applications' access control rules... The possibilities for managing your enterprise security are nearly unlimited and WebADM's flexibility makes it possible to implement any enterprise security requirement.

WebADM is compatible with Novell eDirectory, Microsoft Active Directory 2008 and later, OpenLDAP, Apple OpenDirectory, Oracle/Sun Directory and RCDevs Directory Server. Other directories might work but are not tested nor supported by RCDevs. WebADM can manage and federate all your organization directories in one single interface. It connects your Active Directory, Novell, OpenLDAP all together and provides a hierarchical view, delegated administration and powerful management for your directories.
With OpenOTP, it implements your centralized authentication system, working with your existing directories and domains.

WebADM understands both Microsoft Active Directory domains and UNIX PAM-LDAP users. You can seamlessly manage both systems from the interface. Better, WebADM can extend your Active Directory users (with POSIX functionalities) so that they work with your PAM-LDAP UNIX systems. WebADM is also the only software which able to unify your Microsoft and UNIX infrastructure.

WebADM does not use static LDAP object administration templates. Instead, it is able to read and understand any LDAP directory schema. With this information, it is able to provide dynamic administration interfaces for managing existing objects with their attributes and create new ones. To achieve this, WebADM includes a set of objectclass and attribute specifications providing information for manipulating specific data types. That means, when you connect a WebADM to an LDAP directory, it will read the LDAP server schemas and will immediately be able to manage the directory objects, without needing specific configurations or new object manipulation templates.

WebADM is also able to manipulate Unix, Windows accounts, groups and whatever data your directory is able to store, without additional configurations.
WebADM supports delegated administration and fine-grained access control to LDAP resources.
Administrators can be created at different levels of the tree structure, with different privileges and views. WebADM includes all the necessary features to create new administrators, assign them quotas or settings, restrict tree access, etc... With Novell eDirectory, WebADM takes advantage of the LDAP built-in permissions (ACLs). Administrators can create new contexts with sub-administrators and assign them rights in the limit of their own authorizations, but without compromising the directory security.

WebADM can be used as a central management system for multiple LDAP trees. With the OptionSets, it provides a very simple way to assign settings to specific contexts. And, in order to provide even more detailed management policies, the OptionSets work with inheritance, so the settings can be re-defined into sub-contexts, or quota can be affined at sub-tree levels...

WebADM uses client certificates as default and recommended authentication mechanism for more security when administering LDAP resources. It includes its own PKI subsystem to create, renew, distribute and revoke user/server certificates. It also provide an OCSP endpoint for certificate revocations checks by client systems.

Starting from WebADM version 1.4.2, any high availability and clustering feature require an RCDevs Enterprise license. Without a valid license file, the HA and cluster features are automatically disabled.

Files and Folders

Find below the WebADM software installation file structure and important files.

/opt/webadm/bin/: Location for WebADM service binaries and startup scripts.
- webadm: WebADM executable control script for starting and stopping the server processes.
  To start WebADM from a command line, issue ./webadm start. To stop WebADM, issue ./webadm stop.
- setup: Initial WebADM setup script run by the self-installer. The setup can be re-run manually at any time. The 'setup slave' command provides a slave mode setup for clustered environments. Please look at the WebADM High Availability documentation for details.
/opt/webadm/doc/: Location for WebADM documentation resources.
- /opt/webadm/doc/scripts/: This folder contains some useful scripts such as the tool for creating and renewing WebADM SSL certificates.
/opt/webadm/conf/: Location for WebADM configuration files.
- webadm.conf: Main configuration file. Defines the basic WebADM startup parameters, the location of WebADM-specific LDAP containers, WebADM proxy-user account DN, etc...
  Please look at Appendix A for an example of webadm.conf file with explanations.
- objects.xml: XML configuration file that defines the LDAP objects supported by WebADM and their related parameters. You can edit the XML definitions in this file to customize many aspects of the WebADM behavior.
- servers.xml: XML configuration file that specifies the server connections for LDAP, SQL, Session Server, PKI, SMTP and HTTP proxies.
  Please look at Appendix B for an example of the servers.xml file with explanations.
- rsignd.conf: PKI server (Rsignd) configuration file. Defines the integrated certificate authority settings and its clients. Please look at Appendix C for an example of rsignd.conf file with explanations.
- webadm.env: Some runtime environment variables can be re-defined in this file. Please look at the bin/webadm startup script for the list of variables and the syntaxes. The following variables can be set:

• INTERFACE: The IP address the HTTP services must listen on.
• HTTP_PORT_STD: The HTTP unsecured port used for Administrator Portal and WebApps. This port is not used and is a redirection to the HTTP_PORT_SSL port.
• HTTP_PORT_SSL: The HTTP SSL port used for Administrator Portal and WebApps.
• SOAP_PORT_STD: The HTTP unsecured port used for the Web Services.
• SOAP_PORT_SSL: The HTTP SSL port used for the Web Services.
• CACHE_MEMSIZE: The amount of memory allocated to the WebADM shared caches.
• REDIS_MEMSIZE: The amount of memory allocated to the WebADM session manager service (ie. the local Redis instance).
• REDIS_NOSYNC: Set to Yes to disable session server replication over the cluster.
• SSL_PROTOCOL: For example: 'export SSL_PROTOCOL="ALL -SSLv2 -SSLv3 -TLSv1 -TLSv1.1"' will disable SSLv2, SSLv3, TLSv1, TLSv1.1 and only allow TLSv1.2.

license.key: The license file (if any) provided by RCDevs or its partners for WebADM Enterprise use.
- /opt/webadm/websrvs/: Location for WebADM Web Services. Applications are provided with self-installers and are automatically installed in this place.
- /opt/webadm/webapps/: Location for WebADM Web Applications. Applications are provided with self-installers and are automatically installed in this place.
- /opt/webadm/lib/: Location for WebADM system libraries.
- /opt/webadm/libexec/: Location for WebADM system executables.
- /opt/webadm/logs/: Location for log files produced by all the WebADM services.

The log files in WebADM are:

webadm.log: This is the main WebADM log file which includes general startup errors, Administrator Portal events, Manager API events, WebApps' events, Web Services' events.
Any Web Service API including SOAP, JSON, JON-RPC, REST, XML-RPC logs its events to this log file.
sessiond.log: This log file contains the session server errors (i.e. the local Redis instance errors and warnings).
rsignd.log: This log file contains the PKI server events (both errors and client requests).
watchd.log: This log file contains the WebADM connector status heal check errors.
/opt/webadm/temp/: Location for WebADM temporary data files. Under this directory, you will find service PID files, socket files, Redis database dump files, license cache and license token.
/opt/webadm/pki/: Location for WebADM PKI server files and SSL certificate(s). This folder contains the WebADM CA signing certificate and key under the 'ca' sub-folder. The WebADM SSL certificate and key file used by the HTTP and Rsignd services are webadm.crt and webadm.key. Custom certificate and key used for HTTPS access to port 443 (WebADM Admin portal and webapps) are also stored here (custom.crt and custom.key).
WebADM automatically checks the configuration files for syntax errors or mistakes and writes any problem discovered in the log file /opt/webadm/logs/webadm.log or directly in the startup script output.

WebADM configuration files are documented inline. Please look at the appendixes in this document for the default configuration files with comments.

WebADM Components

The WebADM server is composed of several server components and Web Portals, bundled into one unique application. These components include:

Network Services

HTTP Server

WebADM provides only Web-based user interfaces and includes its own HTTP server which provides the administrator portal, the WebApp portal and a Web Services information portal. By default, all the Web interfaces are running over HTTPS on port 443.

The Web server includes a high performance multithreaded caching system which uses shared memory for maximum service responsiveness.

SOAP Server

WebADM registered applications provide SOAP/XML interfaces only. The SOAP server component provides the HTTP and HTTPS listeners over which the SOAP/XML interfaces are accessible. By default, the SOAP service is running on HTTP port 8080 and HTTPS port 8443.
The SOAP server includes a high performance multithreaded caching system which uses shared memory for maximum service responsiveness.

Session Manager

Most of the WebADM registered applications require storing session data, timers, counters and object locks. The WebADM session manager provides those functionalities in a very high performant and distributed way. Best of all, a cluster of WebADM servers is always connected to a single session manager at-a-time for keeping any work data synchronized. This ensures the clustered systems are not affected by some kind of replay attacks and are able to handle the failover and load-balancing in the best conditions.

Watchd Server

WebADM >= v1.4 includes a new daemon called watchd which is responsible for checking the server connector statuses in real-time. Watchd permanently tests the connections for all servers declared in conf/servers.xml and informs WebADM about the current selection(s). With Watchd service running, your high-availability WebADM cluster is more efficient than ever for dealing with automatic connectors' failover and dead-peer detection.
The watchd service is activated only when WebADM is running with an Enterprise license.

PKI Server

WebADM includes its own PKI system for issuing user certificates. The PKI functionalities are used by the administrator portal and some WebADM applications.
For security requirements, the PKI is working in client-server mode and the signing server does not run under the same system user than the other WebADM services. This ensures the Certificate Authority (CA) component cannot be accessed even through a breach in the other components.

As for the session manager, a clustered system should use only one PKI server for maintaining the coherence in the certificate serial numbers.

Services Start and Stop

The WebADM startup script (webadm) is located in the bin/ directory. You can use the commands webadm start, webadm stop, and webadm restart to start, stop, or restart the WebADM services.

The startup script is responsible for starting and stopping the apache, the session manager (Redis) and the PKI services.

WebADM administration action logs are accessible in the Databases menu in WebADM. System logs are accessible in the logs/webadm.log file.

You can also manage WebADM services using systemctl, as the WebADM setup script handled the service registration.

Web Portals

The Administrator Portal

This portal allows administrators to manage the LDAP objects of the organization, setup and configure WebADM applications. It provides a tree view of the LDAP organization, an object editor and many wizard-based LDAP operations. The administrator portal is accessible at the URL: https://yourserver/.

After authentication with a super_admin account defined in webadm.conf you arrive on the WebADM framework Administrator Portal:

The main Admin Portal menu at top of the page gives instant access to:

The Home Menu: This page display a summary of the administrator user details, installed applications, administrative options and tree options for the LDAP login context (see sections AdminRoles and OptionSets for details).
When logging in as a super administrator (see WebADM main configuration file conf/webadm.conf), and if WebADM is not properly installed, the home page displays the button to access the initial setup wizard.

The Admin Menu: This is one of the most important menu.

It displays a list of buttons for getting information concerning the LDAP server and schema, WebADM configurations, registered Domains, MountPoints and applications. It includes buttons for retrieving the Certificate Authority (CA) public certificate and the server SSL certificate, as well as buttons for flushing the WebADM caches.

The Cluster Menu: This menu appears only if your WebADM is configured in Cluster mode. It displays status for your cluster in real time, warning and errors regarding the configuration, session server replications...
You can also jump to the other nodes by clicking (LOGIN) button on the desired WebADM node. You will be redirected in your web browser.

The Object Creation Menu: It displays a list of object that can be created. The listed objects are those which are specified in the object specifications file (conf/objects.xml). See section Creating Objects for details.
The first object of the list is a generic LDAP object used for creating WebADM configuration objects such as MountPoints, AdminRoles, OptionSets, Domains, WebApps and Web Services. It includes a drop-down list for selecting one of these object types.

The Search Menu: It allows searching for LDAP objects. See section Searching Objects for details.

The Import Menu: It allows importing LDAP objects in batch using LDIF or CSV file formats. See section Importing Objects for details.

The Databases Menu: It displays the list of SQL log tables, application localized message tables, issued certificates table, the Network devices table...

The Statistics Menu: It displays the statistics usage of different components or services.

The Applications Menu: It displays the list and status of the registered WebADM WebApps and Web Services.

The About Menu: It displays WebADM version information, changelog and some RCDevs contact email addresses.

The WebApps Portal

The WebApp portal displays the list of registered applications with the links for directly entering them. This portal is accessible at the URL: https://yourserver/webapps/.

A WebApp named mywebapp can be accessed directly at the URL: https://yourserver/webapps/mywebapp.

The /webapps/ HTTP location contains all the necessary resources for running a WebApp, including stylesheets and image references. This means there are no references pointing to other locations on the Web server when you access a WebApp. The WebApps URL can also be easily placed behind a reverse proxy, which redirects URLs only for the WebApps location. This can be useful if you want to expose the WebApps over the Internet.

If you run a system with multiple servers, the admin portal can be disabled too in the WebADM main configuration file (conf/webadm.conf).

The Web Services Portal

This portal is only informational and displays the list of registered Web Services with their service descriptions files (WSDL). The Web Services portal is accessible at the URL: https://yourserver/websrvs/.

Web Services

RCDevs solutions (example: OpenOTP) run on top of the WebADM Server. The solutions are generally composed of both Web Services and end-user Web Applications (WebApps). WebADM is a container (application server), which embeds the HTTP and SOAP engines required by Web Services and WebApps.

A WebADM Web Service is a pluggable component to be installed (deployed) in WebADM. The Web Services provide final functionalities such as user authentication services. The Web Services provide:

A SOAP XML interface.
A WSDL service description file.
A graphical configurator.

You can review the list of registered Web Services and their status by categories in the Application Menu.

Web Applications

A WebADM Web Application (WebApp) is a pluggable component to be installed (deployed) in WebADM. WebApps are generally companion application for some Web Services. For example, RCDevs OpenOTP Software Token requires the end users to register their secret Token keys, resynchronize their token application, etc... The Web Applications provide:

Some public Web pages.
Optional authentication with PKI, or Domain login (depending on the WebApp purpose).
A graphical configurator.

You can review the list of registered Web Services and their status in the Application Menu.

RCDevs offer multiple WebApps for many purposes like:

Reset LDAP password,
Renew user certificate,
Register an SSH key,
Register a Token,
e-Sign a document and much more...

The Manager Interface

The Manager is a remote procedure call (RPC) interface which provides access to some WebADM user management functions and operations exported by your registered applications. The Manager also allows external systems such as Web portals to remotely trigger user management operations and actions from the network.

The Manager interface is accessible at the URL: https://yourserver/manag/.
Please look at the section using the Manager Interface for details about the Manager Interface.

Configuration Files

The configuration files are self-documented. Please read them as part of this documentation.

The following settings are part of the main WebADM configuration file (conf/webadm.conf).

admin_auth: Administration Portal's authentication mode which can be:
- PKI: WebADM requires a client certificate and a login password.
- DN: WebADM requires a login DN and a password.
- UID: WebADM requires a domain name, a login name and a password.
- OTP: Like UID with an OTP challenge.
- U2F: Like UID with a FIDO-U2F challenge
- MFA: Like UID with both OTP and FIDO-U2F challenge

Using certificates is the most secure login method. To use certificate login, you must log in WebADM and create a login certificate for your administrators.

The UID mode requires a WebADM domain to exist and have its User Search Base set to the subtree where are located the administrator users. When using UID and if there is no domain existing in WebADM, the login mode is automatically forced to DN. You will also need to log in with the full user DN and set up a WebADM domain to be able to use the UID, OTP or U2F login mode.

list_domains: Show the domain list in a drop-down list in when auth_mode is set to UID, OTP or U2F.
default_domain: When auth_mode is set to UID, OTP or U2F, this defines the default domain when left blank. If list_domains is enabled, the default domain is pre-selected.
manager_auth: Manager API's authentication method. Only UID, PKI and DN are supported here. If you set the admin_auth with multi-factor (PKI, OTP or U2F), then you must either use manager_auth PKI or UID with a list of allowed client IPs (see below).
manager_clients: Optional list of client IPs which are allowed to use the Manager API. When admin_auth is configured with multi-factor and manager_auth is set to UID, then this client list is mandatory.
proxy_user: The proxy user is used by WebADM for accessing LDAP objects over which the administrator user does not have read permissions, or to access the LDAP resources out of an administrator session. The proxy user should have read permissions on the whole LDAP tree, and write permissions on the users and groups used by the WebApps and Web Services. A well-configured proxy user is mandatory for WebADM to work correctly.

Be sure to respect your directory password complexity policy for the proxy user password and to have the SSL enabled. Else, WebADM will not be able to create the proxy user during the graphical setup.

super_admins: Super administrators have extended WebADM privileges such as setup permissions, additional operations and unlimited access to any LDAP encrypted data. Access restriction configured in the WebADM OptionSets and AdminRoles does not apply to super admins. You can set a list of individual LDAP users or LDAP groups here.
With ActiveDirectory, your default administrator account should be something like cn=Administrator,cn=Users,dc=mydomain,dc=com. And you can replace the sample super_admins group on the second line with an existing security group. WebADM administators do not necessarily need to be domain admins. Fine grained permissions can be configured.
container_oclasses: List of LDAP object classes to be considered by WebADM as LDAP containers.
user_oclasses: List of LDAP object classes to be considered by WebADM as LDAP users. user_oclasses is used to build the LDAP search filter when auth_mode is set to Domain.
If your super administrator user does not have one of these objectclasses, then be sure to add one of its object classes to the list.
group_oclasses: List of LDAP object classes to be considered by WebADM as LDAP groups.
webadm_account_oclasses: List of LDAP object classes (extensions) to be considered by WebADM as WebADM account objects. WebADM accounts are usable by Web Services and WebApps.
webadm_group_oclasses: List of LDAP object classes (extensions) to be considered by WebADM as LDAP groups with WebADM settings. Group settings are usable by Web Services and WebApps.
webadm_config_oclasses: List of LDAP object classes to be considered as WebADM configuration objects.
ignored_attrs: List of LDAP attributes to be ignored by WebADM when creating or copying objects. This is a requirement for managing Microsoft ActiveDirectory users and groups.
adminroles_containers, optionsets_container, webapps_container, websrvs_container, domains_container, clients_container: WebADM containers required by WebADM for storing configuration objects. You have to change the container locations to match your LDAP tree base and constraints.
session_timeout: Here, you can set the timeout (in seconds) of a WebADM session. Sessions will be closed after this period of inactivity.
cache_timeout: Here, you can set the WebADM internal cache timeout.
languages: List of languages to be supported by your WebADM applications. The languages are used by the WebADM localized messages editor and for editing LDAP language attributes.
encrypt_data: Set to Yes if you want WebADM to encrypt LDAP sensitive data such as passwords, keys and session manager sessions with the AES-256 algorithm.
encrypt_key: This is the encryption key(s). The encryption key(s) must be 256bit base64-encoded random binary data. Use the command 'openssl rand -base64 32' to generate a new encryption key.

If you change the encryption key, any encrypted data will become invalid!
You can set several encryption keys for key rollout. All the defined keys are used for decrypting data. And the first defined key is used to (re-)encrypt data.

encrypt_mode: WebADM provides 2 methods for user data, application settings and inventory data encryption:

The standard encryption (Standard): This is the default encryption mode when you set encrypt_data to Yes. In this mode, any sensitive data is encrypted with the WebADM encrypt key. The encryption uses AES-256 in CBC block cipher mode and PKCS#7 padding. It is resistant to LDAP object copy out of WebADM.
The advanced encryption (Advanced): This mode is similar to the Standard mode but the encryption works per-object. Any encrypted data can also not be copied from one LDAP object to another. Also, LDAP objects cannot be moved or renamed out of WebADM without breaking the encryption.

encrypt_hsm: Set to Yes to enable HSM hardware encryption. The sensitive user data and other critical data will be encrypted with the hardware encryption module(s) defined with the hsm_model and hsm_keyid settings below. Setting No disables the hardware-based encryption of any updated data but does not prevent existing data (encrypted with the HSM) to be decrypted. You can also set it to No in order to switch from hardware encryption mode back to software encryption mode.
hsm_model: WebADM supports hardware security modules. When enabled, the hardware-based security complements the WebADM default software encryption: very sensitive user data like Token secrets or inventory data are transparently encrypted by the connected HSM(s) whereas other (less sensitive) data are encrypted using WebADM software encryption. WebADM currently supports Yubico's YubiHSM. Several YubiHSM modules can be used concurrently (in failover and load-balanced mode). Moreover, the addition or removal of HSM modules is hot-plug.
hsm_keyid: Like with the software encryption, multiple HSM key IDs (i.e. key handles) can be used concurrently and the rollout of a new AES hardware master key is supported. You can set several encryption key IDs for automatic key rollout. All the defined keys are used for decrypting data. And the first defined key is used to (re-)encrypt data.
data_store: It is now possible to choose the data storage mechanism to be used for storing user data and settings. By default, WebADM stores any user and group metadata in the LDAP objects. By setting the data store to 'SQL', these metadata are stored in a dedicated SQL table. LDAP data store remains the preferred option because it maximizes the system consistency. SQL data store should be used only if you need read-only LDAP access for the proxy_user.
group_mode: The group mode defines how WebADM will handle LDAP groups.
- Direct: WebADM finds user groups using the memberof_attrs defined above.
  In this case, the group membership is defined in the LDAP user objects.
- Indirect: WebADM finds user groups by searching group objects which contain the user DN as part of the member_attrs.
- Auto: Both direct and indirect groups are used.
- Disabled: All LDAP group features are disabled in WebADM.

By default, (when group_mode is not specified) WebADM use the auto mode.

ldap_cache: LDAP cache increases a lot of performances under high server loads. The cache limits the number of LDAP requests by storing resolved user DN and group settings. When enabled, results are cached for 300 secs.
ldap_routing: LDAP routing enables LDAP to request load-balancing when multiple LDAP servers are configured in servers.xml. You should enable this feature only if the LDAP server load becomes a bottleneck due to a large number of users (ex. more than 10000 users).
ldap_uidcase: Set to Yes if you need to handle LDAP login names with case sensitivity. By default, LDAP login names are case-insensitive.
enable_admin, enable_webapps, enable_websrvs, enable_manager: You can optionally disable main WebADM features if you run multiple WebADM servers for different purposes.
For example, if you don't want to provide the Administrator Portal on an Internet-exposed WebApps and Web Services server. By default, all the functionalities are enabled.
log_format: Format of the WebADM log file (/opt/webadm/logs/webadm.log). Set to CEF to enable Common Event Format logs to be used with Splunk servers.
log_syslog: Enables syslog logging (disabled by default). When enabled, WebADM system logs (any event in webadm.log) are sent to both the WebADM log files and the syslog.
syslog_format: Format of the WebADM syslog events. Set to CEF to enable Common Event Format logs to be used with Splunk servers.
syslog_facility: Syslog facility to be used which defaults to LOG_USER.
alert_email: Email recipient address used by WebADM for sending system alerts. You can set several recipient addresses with the comma separator.
cloud_service: Enable RCDevs cloud service on your WebADM server. This is needed if you have a cloud license, want to benefit of Push login, Signature mecanisisms, RCDevs SMS service, RCDevs cloud PKI...
reverse_proxies: If your WebADM server is used behind a reverse proxy or load-balancer, you need to set the IP address(es) of your reverse proxy server(s). Your proxy must be configured to create the HTTP_X_FORWARDED_FOR and HTTP_X_FORWARDED_HOST headers for WebADM to behave correctly. You should add your last reverse-proxy IP addresses separated by a comma to the reverse_proxies directive:

reverse_proxies "<YOUR_LASTREVERSEPROXY_IP1>", "<YOUR_LASTREVERSEPROXY_IP2>"

If you have more than one reverse-proxy between your WebADM server and clients, the reverse_proxies directive should be configured with number of reverse-proxies that are between the WebADM server and the clients, so WebADM is still able to get the actual client IP address. In that case, the directive must be configured like this:

reverse_proxies "<YOUR_LASTREVERSEPROXY_IP1> <NUMBER_REVERSE_PROXIES>", "<YOUR_LASTREVERSEPROXY_IP2> <NUMBER_REVERSE_PROXIES>"

waproxy_proxies: If you use WebADM Publishing Proxy from RCDevs (WAProxy) for publishing applications and services on public networks, then you must set the IP address(es) of the WAProxy server(s). Enable this setting ONLY if you are using RCDevs WAProxy as reverse-proxy! It is not intended to be used with any other reverse-proxies. You should add your WAProxy’s IP addresses separated by a comma to the waproxy_proxies directive:

waproxy_proxies "<YOUR_WAPROXY_IP1>", "<YOUR_WAPROXY_IP2>"

If you have at least one or more reverse-proxy between your WAProxy server and clients, the waproxy_proxies directive should be configured with number of reverse-proxies (including WAProxy server) that are between the WebADM server and the clients, so WebADM is still able to get the actual client IP address. In that case, the directive must be configured like this:

waproxy_proxies "<YOUR_WAPROXY_IP> <NUMBER_REVERSE_PROXIES>", "<YOUR_WAPROXY_IP2> <NUMBER_REVERSE_PROXIES>"

check_versions: Enables WebADM versions checking. WebADM will check for new product versions for itself and for all the registered applications (web apps and web services).
check_licenses: Enables WebADM license update checking. WebADM will check if a license update is available on RCDevs online servers. This feature requires an Enterprise license to be already present.
webapps_theme: WebApps theme for WebApps. Only the default theme is available.
unlock_message, unlock_subject: Email message body and subject to be sent to a user when a WebApp access is temporarily unlocked by an administrator. The following variables are supported: %USERNAME%, %USERDN%, %USERID%, %DOMAIN%, %APPNAME%. These additional variables are available depending on the context: %APPNAME%, %APPID%, %TIMEOUT%, %EXPIRES%.
org_name, org_logo, org_site, org_from: You can customize your organization's name, logo file and website URL to be displayed in the Web applications. The logo file must be a PNG image with a size of 100x50 pixels, stored under the WebADM conf/ directory. You can alternatively set the absolute path if the logo file is outside the WebADM config directory.
The org_from allows you to configure the sender email address for emails sent by WebADM (ex. alerts, WebApp unlock…).
treeview_items: When an LDAP container which contains more than 1500 child objects is expanded in the Admin tree view, WebADM automatically displays an inline search input to filter the child results. The treeview_items defines the display limit and is set to 1500 by default.
treeview_width: This defines the default width (in pixel) for the tree view (left panel) in WebADM Admin Portal. In some circumstances, it can be useful to enlarge the tree view for a better display.
default_portal: It is possible to define which Portal corresponds to the default WebADM URL (without the trailing /admin, /webapps and /websrvs).

Other Configurations

You can create a webadm.env file in the WebADM conf/ directory to modify some internal configurations such as port numbers and listen to an interface. You can change the following variables:

INTERFACE: Defines the network IP address to listen on. The default is 0.0.0.0 (any interface).
HTTP_PORT_STD: Defines the HTTP unsecured port used for the Admin Portal and WebApps. This port is not used and is a redirection to the HTTP_PORT_SSL port. The default port is 80.
HTTP_PORT_SSL: Defines the HTTP port over SSL used for the Admin Portal and WebApps. The default port is 443.
SOAP_PORT_STD: Defined the SOAP port in cleartext to be used for Web Services. The default port is 8080.
SOAP_PORT_SSL: Defined the SOAP port over SSL to be used for Web Services. The default port is 8443.
CACHE_MEMSIZE: Defines the memory size with a memory unit identifier to be allocated to the shared cache. The default size is 32 Mo (32M). This environment variable and the following ones are auto-adjusted by WebADM depending on the user scaling. You should not need to change it.
REDIS_MEMSIZE: Defines the memory size with a memory unit identifier to be allocated to the session manager. The default size is 256 Mo. Both CACHE_MEMSIZE and REDIS_MEMSIZE are auto-adjusted according to the number of users defined in the license file.
REDIS_NOSYNC: Defines if the WebADM session server replication should be disabled. This variable should be kept to its default value unless you really know what you are doing.

The format for the webadm.env file is:

INTERFACE=0.0.0.0
HTTP_PORT_STD=80
HTTP_PORT_SSL=443
SOAP_PORT_STD=8080
SOAP_PORT_SSL=8443
CACHE_MEMSIZE=32M
REDIS_MEMSIZE=256M
REDIS_NOSYNC=No

WebADM will automatically adapt the threads and memory scaling according to the user amount (as defined in your Enterprise License). You generally do not need to touch these settings manually.

Encrypting Configuration Passwords

You can optionally encrypt any password in the configuration files for webadm.conf, servers.xml and rsignd.conf. For example, you can use the tool bin/pwcrypt to convert a cleartext password to an encrypted form (ex. your WebADM Proxy User LDAP password). The encrypted password will look like {wcrypt}ZuWw1Ie2qxlguTF77mDjmQ==.
You can use the new password value as is (ex. proxy_password "{wcrypt}ZuWw1Ie2qxlguTF77mDjmQ==").

This feature requires an Enterprise License. The encryption mechanism is bound to secret data in your encoded license file. The encryption is also per RCDevs customer and an encrypted password value cannot be used with another license.

LDAP Management

With WebADM, administrators can create and edit LDAP users, groups and other objects. Administrators can also extend existing LDAP users or groups with WebADM functionalities.

Common LDAP Objects

User Accounts

User accounts are LDAP standard user objects. WebADM considers a user account is an object containing at least one object class from the user_oclasses list in the WebADM main configuration file (conf/webadm.conf).

WebADM provides its own user account schema named webadmAccount. The webadmAccount schema provides additional attributes, such as the webadmSettings, or webadmData for normal users and groups. These attributes are required by the registered Web Services and WebApps to store user-specific settings and user metadata. The webadmAccount objectclass is an LDAP extension class and cannot be created standalone. It must be used together with a structural user object class.
WebADM considers a WebADM account is an object containing at least one object class from the webadm_account_oclasses list in the WebADM main configuration file (conf/webadm.conf). In Figure 10, WebADM Account is an LDAP user object with the webadmAccount extension.

WebADM can create standalone users, or extend existing users by adding new object classes to the user object. See section Extending Objects for details.

The LDAP attribute corresponding to the login name (i.e. RADIUS username used for VPN logins) depends on the WebADM configurations. It can be the object name (CN) as well as the UID attribute, sAMAccountName, userPrincipalName, the mobile number, or anything else. WebADM just needs to know what attributes can be used for the logins. This is adjustable in the objects specification file (conf/objects.xml). By default, the username is the UID LDAP attribute.

WebADM accounts can contain several application settings. The list of available settings depends on the registered applications and the scope of the settings. Any Public or LDAP application setting can be set at the user or group level.

WebADM and its applications use LDAP bind for static password checking. That means that the user objects must be combined with a bindable object class and must have their LDAP password set.

To be used by the Web Services and WebApps, an LDAP user must be a WebADM account. WebADM user accounts are those containing the webadmAccount LDAP object class. You can enable the WebADM features on any existing LDAP user by extending it with the webadmAccount extension (with the object extension action in the object editor).

You can assign WebADM settings to LDAP groups (instead of users) by extending the groups with the webadmGroup extension. Like with users, this is done with the object extension action in the object editor.

User Groups

User groups are LDAP object that contains a list of LDAP members, each representing the Distinguished Name (DN) of the user object belonging to the group. WebADM considers a group is an object containing at least one object class from the group_oclasses list in the WebADM main configuration file (conf/webadm.conf).

Groups are often used for access purposes. Members of a particular group are allowed to access different services than members of another. Groups are also used for storing application settings common to all group members. This often reduces the overhead in managing settings stored in user accounts. In that case, the groups must be extended with the webadmGroup object class.

WebADM supports two methods to assign users to groups:

Using group membership: The user account includes a groupmembership (such as memberOf) attribute specifying which group DNs it belongs to.

Using group members: The group object includes a member list containing the user DNs.

WebADM provides different ways to define groups according to the LDAP infrastructure configured with WebADM. With an OpenLDAP or RCDevs Directory you can found:

Static groups: The group member list is statically defined and updated manually.
Dynamic groups. The group member list is defined as a dynamic LDAP query (Dynamic Member Query). The member list is computed at runtime when the group members are queried.
Dynamic groups require a Dynamic Group Query Identity attribute which defines the user account DN to be used internally by Novell eDirectory, for performing the LDAP searches needed for looking up the dynamic group members.

User groups and group settings are cached for 5 minutes in order to optimize group searches and user setting resolutions. This has the side effect that user groups and group settings' changes may be delayed for a maximum time of 5 minutes when used by WebApps and Web Services.

Dynamic groups are supported on Novell eDirectory and RCDevs Directory Server only.

Administrative Accounts

WebADM considers that any bindable LDAP user object with sufficient access rights to the LDAP server can be used for LDAP administration purposes, with access to the Admin Portal or the Manager interface. Access to any of these WebADM management interfaces requires the LDAP users to be configured in the super_admins list in conf/webadm.conf or to be part of a WebADM AdminRole (see the AdminRoles section for details).

In WebADM, administrators can create and edit LDAP objects, create new contexts with sub-administrators, and assign permissions in the boundaries of their own LDAP restrictions and permissions. It is possible to restrict which features and operations delegated administrators can access by using WebADM OptionSets and AdminRoles.

Permissions

By default, a newly created administrator has no write permissions.

With Novell eDirectory, write permissions must be created by adding permission attributes (ACL) to LDAP contexts. You can use the Add Permissions action when editing a container object to create new permissions.

With Microsoft ActiveDirectory, the user must be added to an administrative group where fine-grained permissions configured on that group according to what you want to allow in terms of LDAP manipulation.
With OpenLDAP, the user permissions must be added in the OpenLDAP server configuration file (slapd.conf).

By default, a user does not have any other rights than reading access. He is able to manage his own user data, change his password or renew his own certificates. If another administrator creates context permissions for him, he becomes an administrator in these contexts.

Certificates

WebADM supports certificate-based authentication for simpler and more secure access to the Administration Portal and WebApps. It provides the necessary pages and actions to easily manage administrator certificates. Supported operations are certificate creation, deletion, renewal, download.

Certificate-based authentication is highly recommended when using delegated administration and especially when using WebADM for remote administration over the Internet. It adds another level of security while authorizing the administrator's sessions at the web server's level. WebADM provides a wizard to create a new administrator certificate and parameters allow to set the type and validity time for the new certificates. See the Managing Certificates section for details.

An administrator is able to renew, remove or add new certificates for other users he manages or for himself.

The WebADM internal PKI (RSignd) is the default certificate management system. If you already have an internal PKI, you can configure WebADM as a subordinate certificate authority.

Any bindable object is able to log into WebADM (if declared as super/other admins). That means any user object with a bind password and a login certificate is able to enter WebADM. To prevent normal users from logging in WebADM, use the certificate-based login instead of the Domain or DN login modes. Then, only administrators owning a valid administrator certificate can log in.

Containers

LDAP containers (or contexts) are objects, which can contain child objects. WebADM considers a container is an object containing at least one object class from the container_oclasses list in the WebADM main configuration file (conf/webadm.conf). Common containers are Organizations, Organizational Units, Countries, Locations, Domains, etc... When WebADM is used to manage a lot of users, it is highly recommended to structure the LDAP tree with containers in order to reduce the number of child objects within one container.

WebADM Configuration Objects

Configuration objects are WebADM-specific LDAP objects that are used by WebADM for storing persistent configurations in LDAP. WebADM considers an LDAP configuration object is an object containing at least one object class from the webadm_config_oclasses list in the WebADM main configuration file (conf/webadm.conf). The type of the configuration object is determined by the webadmConfig attribute which can be either Domains, Clients, AdminRoles, OptionSets, MountPoints, WebApps or WebSrvs.

WebADM creates a set of LDAP containers and objects during its setup for storing WebADM Domains, OptionSets, MountPoints, client policies, Web Services and WebApps configurations. The LDAP locations for these objects are defined in the main WebADM configuration file (conf/webadm.conf). This tree structure is mandatory for WebADM to operate correctly.

WebADM configuration objects are accessible from the Admin menu or directly from the dc=WebADM subtree (can also be an OrganizationalUnit (OU), AD container (CN)...)

WebADM AdminRoles

WebADM includes the concept of delegated administration. It also makes the distinction between Super Administrators and Other Administrators. Super Administrator is an LDAP administrator (ex. AD Domain Admin users) which are configured in the super_admins list in conf/webadm.conf. The Super Administrators have unlimited access to any feature of WebADM. On the contrary, Other Administrators are the delegated administrators for which you can define precisely what features and administration operations are allowed through WebADM AdminRole objects. Another Administrator is also any LDAP user which is a member of one or several WebADM AdminRole(s).

LDAP access rights for both Super Administrators and Other Administrators MUST be set at the LDAP server level with dedicated LDAP ACLs. Any action through WebADM admin GUI or Manager APIs are performed with the permissions of the authenticated user and these permission will be needed on the LDAP in order complete needed operations. This is important to notice that WebADM enforces access control over its own management interfaces but it cannot enforce any security control at the LDAP API level! This means that restricting user operations and features via AdminRole configurations does not prevent an administrator from performing the same operations from another LDAP client software.

All AdminRoles must be stored in the same container (as specified in the WebADM main configuration file) to be read by WebADM at start-up.

WebADM OptionSets

Some WebADM restrictions or “subtree options” can be assigned to specific LDAP contexts using WebADM OptionSets. OptionSets are essentially subtree profiles which can be used for example to define a unicity verification context or limiting the LDAP view depth for delegated administrators. Option sets can also be used to create Organization profiles specifying the default LDAP attributes for member objects within the organization. See section WebADM OptionSets for details.

All OptionSets must be stored in the same container (as specified in the WebADM main configuration file) to be read by WebADM at start-up.

WebADM MountPoints

MountPoints are containers in the LDAP tree that include objects and child containers (i.e. the entire tree structure) from another LDAP server. The objects are not physically present in the tree structure. Instead, WebADM connects at runtime to an external LDAP and renders its contents as if the data were stored in the mounted context. See section WebADM MountPoints for details.

All MountPoints objects must be stored in the same container (as specified in the WebADM main configuration file) to be read by WebADM at start-up.

WebADM LDAP Domains

All the WebADM applications identify a user with a username, a password and a domain name. The domain objects establish the relationship between a domain name and an LDAP tree base. Also, when an application wants to obtain an LDAP user DN corresponding to the provided login information, it will use the domain tree base to build the LDAP search. See section WebADM Domains for details.

All Domains objects must be stored in the same container (as specified in the WebADM main configuration file) to be read by WebADM at start-up.

WebADM Client Policies

A Client Policy provides per-client application access control and customized configurations. The Client Policy objects are also used to customize the behavior of a client application (ex. a VPN server using OpenOTP Authentication Server).

You can create a client policy object having the name of a Web Service's client ID. For example, you use the client names as displayed in the WebADM log viewer for the client object names.

When a client is defined, any request from the corresponding client application (ex. a VPN server with matching client ID), will obey the defined client policy.

For a client, you can restrict users able to use the client application with allowed and excluded group lists. And you can define some Web Service settings which will always be enforced for the client. For example, you want the VPN to authenticate users with LDAP+OTP passwords and Token, whatever policy is defined for the user.

WebADM WebApps and Web Services

These objects are used by WebADM to store registered application configurations. When you register a new application in WebADM, it creates an LDAP object. You can access the application configuration either by editing the application LDAP object or using the Applications menu in WebADM.

All WebApps and WebServices configuration objects must be stored in the same container (as specified in the WebADM main configuration file) to be read by WebADM at start-up.

WebADM-Specific Attributes

WebADM schema (see section WebADM LDAP Schema for details) provides two additional object classes : webadmAccount and webadmConfig.

LDAP objects extended or created with the webadmAccount and webadmGroup object class support the following new attributes.

WebADM Settings Attribute

This attribute is used to store user-specific application settings inside the user or group objects. The object settings have priority over the default application settings for the registered WebADM applications.

The WebADM user setting editor displays a drop-down list containing the registered applications. Select an application and the list of corresponding settings are displayed and available for configuration.

WebADM Data Attribute

This attribute is used by the WebADM applications to store user data such as Token keys and various user data. The WebADM user data editor displays all the data stored by the applications and allows raw edition of the data.

The webadmData contents are encrypted in the LDAP using an AES-256 key which is configured in the WebADM main configuration file (conf/webadm.conf). Only the WebADM administrators are able to read this attribute unencrypted. They can edit the data values with the data editor.

Important note for Advanced encryption
The webadmData encryption uses the LDAP DN together with the encryption key. This is a security mechanism to prevent the same data values from two different users to be encrypted identically. When a user is copied, WebADM handles the re-encryption automatically. But if you export the user in an LDIF file, and re-import it at another location, the webadmData are lost. Features are automatically disabled.

Password Attribute

Any bindable LDAP object must have its password attribute set. Password attributes are defined by the password_attrs setting in the WebADM main configuration file (conf/webadm.conf).
The password encoding and format depends on the LDAP directory type. The encoding and encryption format of passwords is defined in the objects specification file (conf/objects.xml).

Administrators can change user passwords with the Change password action in the object editor.

UID Attribute

WebADM allows specifying multiple attributes to be used as login attributes. Login attributes are defined by the uid_attrs setting in the WebADM main configuration file (conf/webadm.conf).

When a user logs in a WebApp or a Web Service, he enters his login name, domain and password. WebADM computes the LDAP tree base using the information stored in the Domain configuration object and searches for objects of type webadm_account_oclasses, having one uid_attrs corresponding to the provided login name. Then WebADM binds the LDAP directory with the user DN and the provided password.

The same system is used when WebADM Administrator Portal is configured in Domain login mode. But in that case, WebADM will search for any user object of type user_oclasses, having one uid_attrs corresponding to the provided login name.

Certificate Attribute

WebADM uses this attribute to store user certificates in the LDAP accounts.

The private keys are never stored in this attribute. Certificate attributes are defined by the certificate_attrs setting in the WebADM main configuration file (conf/webadm.conf).

WebADM supports storing user certificates in both binary and base64 encoding. The encoding is specified in the objects specification file (conf/objects.xml).

Language Attribute

This attribute is used by the WebADM applications to query the user language. When application messages are localized in several languages (with the WebADM Localized Message Editor), the applications will automatically select the message corresponding to the user language.

Mobile Attribute

This attributes stores the user mobile phone number. It is used by some WebADM applications and services.

Mail Attribute

This attributes stores the user email address. It is used by some WebADM applications.

Voice Attribute

This attribute stores the user biometric voice. It is required when OTP Type setting is configure to VOICE in OpenOTP.

WebADM Config Type Attribute

This attribute is used by WebADM to assign a role to a webadmConfig object (examples of WebADM types are Domain, Trust, OptionSet, MountPoint, Client, WebApp or WebSrv).

WebADM LDAP Schema

The WebADM LDAP schema extension provides 3 additional object classes: webadmAccount, webadmGroup and webadmConfig. See the figure below for the schema detail.

The new LDAP schema entries are automatically registered in the LDAP server schema by the WebADM setup.

Creating Objects

With WebADM, you can create any object type defined in the objects specification file (conf/objects.xml). Yet, if the object is not present in the LDAP schema, it is ignored. The objects specification file defines additional information used by WebADM about the object types and their capabilities. It defines what administrative level is required by an administrator to create an object, the additional object classes to be merged during creation and the available extension classes.

Administrative levels are used to set up level-based object creation restrictions. They are used to control what objects can be created by administrators belonging to a given context. An object specification also includes the minimum administrative level required for the object to be created.

The auxclasses in the object specification is used to consider a set of object classes as a single WebADM object type. It is mandatory for certain object types such as WebADM accounts because the webadmAccount object class is an LDAP extension class. That means, it cannot create a standalone and must be associated with a structural objectclass which defines other LDAP attributes.

The extensions define the object classes with which the object can be extended. For example, an object class corresponding to existing user objects should be extendable with the webadmAccount object class to allow adding WebADM features and settings to existing users.

Objects can be created either from the top menu Create button or directly from the Create button within a context in the LDAP tree. The creation forms will depend on the OptionSets applying on the creation context and on the LDAP schemas corresponding the to the new object DN in case of MountPoint.

The object creation forms are computed dynamically by querying the LDAP schema for the object class and auxclasses, associated attributes and the constraints. They display all the mandatory attributes (merged from all objectclasses) and the optional attributes to be created.

Only those optional attributes configured in the attribute specifications of the WebADM objects specification file (conf/objects.xml) are displayed. This is a display simplification not to show all the merged optional attribute list which can be very long depending on your LDAP.

Some attribute values can be autofilled if default values are defined in the OptionSets which apply on the object creation context.

The creation wizard includes a WebADM Config Object item (with a drop-down list) in the new objects list. This kind of object corresponds to WebADM configuration objects such as Domains, MountPoints, OptionSets, WebApps or WebSrvs.

Editing Objects

The object editor displays useful information about the object, a list of actions to be performed and the list of attributes contained by the object.

The Contextual Action Box

The action box is displayed at the top left of the editorial page. It contains a list of actions to be performed on the object such as deletion, copy, LDIF export, child creation, add permissions, issue certificate... It includes a button to change the user password if the object is used for LDAP binds.

When the edited object is a container containing child objects, copy, delete and export operation can be performed recursively.

A button allows switching to advanced edition mode. By default, the edition form does not display all the object attributes nor all the edition capabilities or attribute list. It displays all the mandatory attributes but only the optional attributes which are defined in the objects specification file (conf/objects.xml). And the behavior is the same for extension classes list and new attributes list.
If required, you can at any moment switch to advanced mode for extended display and capabilities.

The Information Box

The object informational box is displayed at the top middle of the editorial page. It displays useful information for the object such as a unicity check, WebADM settings, data summary, etc...

If some attributes are defined as unique within a specific context, WebADM checks the unicity and display the result and the list of checked attributes in this box. If attributes have to be unique, this must be set in the objects specification file (conf/objects.xml).

The Application Box

This box is displayed at the top right of the edition page (only when an application is registered). All the registered applications can specify some additional actions to be performed by WebADM administrators as part of the user management. Those actions are generally accessible in this box (for the administrators) and through the SelfDesk WebApp (for the end-users).

Object Name

The object name is the value of the LDAP naming attribute for the object. You can change the object name by typing a new name and using the rename button. Generally, the naming attribute is the object Common Name (CN).

You cannot rename a container object which already contains child objects. But you can recursively copy the container to a new one (with another name).

New Attributes

The Add Attribute button allows adding optional attributes supported by any of the object classes composing the object.

Extensions

The Add Extension button allows adding new compatible object classes to the object. When adding an extension, a wizard will ask for the new mandatory attributes and the optional attributes which are defined in the objects specification file (conf/objects.xml).

To see the list of object classes in an object switch to advanced edition mode.

You can remove an extension object class from an LDAP object by switching to advanced edition mode, checking the object class checkbox (in the object class attribute list), and clicking the Apply Changes / Delete Selected button. The object class removal will also remove the object class and all the attributes that are not part of any of the remaining object classes.

Attribute List

The attribute list displays the attributes which have a value defined in the object.

Only the attributes defined in the objects specification file (conf/objects.xml) are displayed by default. This is a display simplification to ease the use of WebADM but you can display all the attributes by switching to the advanced edition mode.

Some action buttons appear under the attribute name such as add values or delete the attribute. These actions are determined upon the attribute constraints in the LDAP schema. For example, if an attribute is optional, then you can delete it, and if an attribute can have multiple values, then you can add values or delete some of them.

The attribute value display is dynamically rendered using WebADM attribute type templates (called WebADM attribute handlers). A set of default templates is already defined to display simple data types such as booleans, texts or members as well as complex data types such as certificates, permissions or WebADM-specific data.

After modifying one or several attribute values, you must commit the changes with the Apply Changes / Delete Selected button at the bottom of the page. Yet, some special attributes call specific modification pages, which should update the attribute values themselves. This is the case for member lists, permissions, WebADM settings, WebADM data, etc...
When an attribute has multiple values, and you want to remove some of them, just select them on the right of the value and click the Apply Changes / Delete Selected button at the bottom of the page.

Moving / Copying Objects

WebADM does not provide actions for moving objects. The objects to be moved must be copied and then the original object should be deleted. To copy from an LDAP server to another, objects can be exported, modified and then re-imported using LDIF.

Copy operations must respect the quotas defined in the OptionSets if you have quotas enabled. Therefore, ensure the copy will not reach your quotas before copying.

It is not recommended to move administrator objects when using certificate-based authentication. Or his certificates must be re-created after moving because the administrator's login DN is part of the certificate data.

Password attributes are invalidated after a copy or import on Novell eDirectory and Microsoft ActiveDirectory. User passwords must also be reset after a copy.

WebADM data inside LDAP objects are encrypted with an AES-256 key and the object DN. The copy action will handle the re-encryption automatically. Yet, an export followed by a re-import at a different place will invalidate the encrypted data.

Exporting / Importing Objects

LDIF Export / Import

WebADM is able to export and import LDAP objects using LDIF files. When editing an object, it is possible to export it or its whole content.

When importing an LDIF file, WebADM operates in two passes:

The first pass creates the objects and all their mandatory attributes.
The second pass adds the optional attributes.

It is not always possible to create objects in one step because some attribute values may include references to other objects that do not exist at creation time (if they are listed later in the LDIF file). It would not respect the directory integrity and would make it impossible to create some objects. Permissions or group members are some good examples.
WebADM allows to export, delete and re-import a subtree with its administrators, permissions and object references by using the two-passes import mechanism.

With Novell eDirectory and Microsoft ActiveDirectory, the user passwords cannot be restored at import. The password also has to be reset after the import.

For super-administrators, it is possible to export LDAD encrypted attributes (such as webadmData) unencrypted. By default, the LDIF export contains the raw data which is stored in the LDAP directory (with encrypted data). Exporting unencrypted data can be useful for backing up your LDAP users and data.

The WebADM LDAP encryption depends on the object's DN. If you export users and then re-import them in another location, any encrypted data will be lost. You can use the unencrypted export/import for this purpose.

CSV Import

WebADM provides a method for creating a large number of objects of the same type in one single step. The CSV Import feature allows importing a file containing raw object data.
The import page asks for the object's type to be created and the creation context.
The import file must be structured that way:

The first line must contain the attribute names corresponding to the values appearing in the same column in the next lines.
The next lines must contain the attribute values for the imported object type. And all the mandatory attributes for the specified object type must be present.
The naming attribute must be the first one listed.
Fields must be separated by commas.

Searching for Objects

WebADM search system provides a simple interface to look for objects based on criteria. It works in two modes:

The simple search mode allows selecting an attribute, searching criteria and the data to be searched.

The advanced search mode provides more detailed searching. You can select the search context and scope, edit the search filter (manually or using the search filter editor) and define what attributes should be searched and displayed.

The list of attributes to be searched in the simple mode as well as the attributes to be displayed in the results are configurable in the objects specification file (conf/objects.xml).

Batch Search Actions

WebADM allows performing batch actions on the resulting entries of a search. The actions that are supported are:

Adding webadmAccount objectclass extension to users.
Removing webadmAccount objectclass extension from users.
Adding objects to groups.
Removing objects from groups.
Setting LDAP attributes.
Adding LDAP attribute values.
Setting WebADM applications Settings.
Removing objects.

The syntaxes and details for each batch action are displayed in the batch actions wizard.

WebADM OptionSets

Option sets are used in the WebADM Administrator Portal only and do not interact with the Web Services or WebApps.

When several OptionSets are defined for the same context (even at a different level of the LDAP tree), the options are inherited from the upper tree down to the current context.

All OptionSets must be stored in the same container as specified in the WebADM main configuration file (conf/webadm.conf) to be read by WebADM at session startup.

An OptionSet is configured with an LDAP DN which corresponds to the scope of application for the options listed hereafter.

Tree Root Context: Set the tree view base for administrators. This option is mainly used to limit the administrators' LDAP access scope in WebADM when using OpenLDAP and Microsoft ActiveDirectory. With Novell eDirectory, the tree access limitation is provided by the LDAP permissions (ACL) which can be set directly on LDAP container nodes. The tree root option prevents administrators from accessing any object out of the specified tree base and reduces the tree view accordingly.

The root context applies to the SQL logs viewer too where the log events corresponding to objects outside the root context are filtered and not displayed.

This option concerns administrators only and is computed at login time. Any administrator located inside the configured target subtree will also have it's LDAP tree view limited to the configured tree root context.
{{< /note >}}

Unicity Context: Defines the LDAP tree base to be used by WebADM for checking unique users' attributes. Unique attributes are defined in the objects specification file (conf/objects.xml).

The unicity context is used for other purposes in WebADM such as the tree base for determining free UID numbers for POSIX accounts.

LDAP Defaults: List of default attribute values which will be autofilled when creating or extending objects inside the target subtree.

Minimum UNIX UID: Auto-incremented UID values will start from this value.
Minimum UNIX GID: Auto-incremented GID values will start from this value.

The following settings allow you to synchronize an Active Directory domain or an EntraID tenant into the LDAP database configured with WebADM.

LDAP Sync Mapping: DN mapping to be applied when syncing from a remote AD/LDAP or handling LDProxy requests.
Ex. Use 'CN=Users,DC=company,DC=com' to map the remote DN suffix to the local target subtree.
Activate New Users: Activate newly-created users or groups during synchronization (AD/LDAP or EntraID).
Sync User Password: Local LDAP password is automatically updated after an EntraID success password check.
When enabled WebADM will fallback to the local LDAP check if EntraID is unaccessible.
EntraID Tenant ID: EntraID tenant identifier.
EntraID Client ID: EntraID Client ID.
EntraID Secret: EntraID secret

Office Coordinates: Defines the GPS coordinates for the mobile badging option to badge from these office coordinates.
Office Networks: This parameter requires office position. It defines internal office IP subnets from which users are allowed to proceed to badge from SelfDesk.
Check Badging Expire: Time during which the badging is effective in hours. By default, it is valid for one hour.
Check Badging Hours: Time slots during which the badging remain possible. When not in these time slots, users can't badge at all.
Badged Users Group: Groups selected to be populated by users who have badged-in.
Office Users Group: Same groups as parameter before but for users badged-in from the office. Requires Office coordinates.

Local Country: The country which will not be considered as remote for the users who badge there.
Remote Quota: The maximum number of days of remote work possible per country. Defined by the country code, followed by a column and the number of days : 'FR:32,BE:25,LU:45'. The users need to have the country defined in their LDAP attributes or the parameter won't be effective.
User Alerts: 3 options that are Password, Certificate and Badging. The first two concerns an expiration that is soon, so it alerts the user. Regarding the password, it works only with Active Directory. The badging alert is for a suer who forgot to badge-out the day before.
Alert Period: The number of days the alert is sent before the expiration. 10 days by default.
Alert Repeat: The number of days the alert is repeated after the first notification that the expiration is soon. 3 days by default.

WebADM AdminRoles

WebADM includes the concept of delegated administration. It also makes the distinction between Super Administrators and Other Administrators. Super Administrator is an LDAP administrator (ex. AD Domain Admin users) which are configured in the super_admins list in conf/webadm.conf. The Super Administrators have unlimited access to any feature of WebADM. On the contrary, Other Administrators are the delegated administrators for which you can define precisely what features and administration operations are allowed through WebADM AdminRole objects. Another Administrator is also any LDAP user which is a member of one or several WebADM AdminRole(s).

LDAP access rights for both Super Administrators and Other Administrators MUST be set at the LDAP server level with dedicated LDAP ACLs. This is important to notice that WebADM enforces access control over its own management interfaces, but it cannot enforce any security control at the LDAP API level! This means that restricting user operations and features via AdminRole configurations does not prevent an administrator from performing the same operations from another LDAP client software.

All AdminRoles must be stored in the same container as specified in the WebADM main configuration file (conf/webadm.conf) to be read by WebADM at session startup.

An AdminRole can be applied to a single administrator account or a group of administrators (but nested groups are not supported).

This option does not apply for super administrators defined in webadm.conf.

Basic Permissions

Allowed Interfaces: Controls which administration interface is available for the selected administrator(s). Admin enables access to WebADM Admin Portal. Manager provides access to the JSON-RPC management interface. By default, access to the Manager interface is denied.
Created Objects: Contains a list of object classes defining which LDAP object types can be created, imported and deleted. Any LDAP object containing at least one of these allowed object classes are authorized for creation, import and deletion.
Allowed Configurations: Defined the list of configuration objects which can be managed under the 'Admin' menu. Note that graphical access (i.e. browsing capability) to the WebADM configuration containers is required for managing WebADM configurations. This setting enables restrictions to the configuration objects when accessed from WebADM but does not prevent an administrator from editing the corresponding LDAP objects from another LDAP interface.
Allowed Databases: Defines which SQL database tables (logs, localized message and inventory) are accessible. The selected database tables are accessible in read-only by default.
Managed Databases: Defines which SQL database tables (log, localized message and inventory) are accessible in write or edition mode. For logs, write access provides deletion of selected entries and purge of old events. For Message and Inventory, write access provides import and management of entries.
Allowed Log Files: Defines which WebADM log files are accessible under the Database menu.
Allowed Applications: Defines which applications (WebApps and Web Services) are configurable by the administrators.

Management Rights

By clicking the Edit button on the right side of the management rights, you can configure what LDAP object management features and WebADM operations are allowed. By default, none of the listed rights is enabled.

Basic Object Edition: Modify attributes, rename and remove LDAP objects.
Add Object Extensions: Add and remove auxiliary object classes with their attributes. This role also provides user activation which consists of adding the WebADM extension on the users and group activation which is required if you need group-based policies.
Edit User & Group Policies: Configure application settings on activated users and groups.
Edit User Application Data: Manually edit application data on activated users and groups.
Manage Group Membership: Add users to group objects and set group membership on the user objects.
Change User Passwords: Initialise and reset user passwords.
Create User Certificates: Create/renew user certificates to be used in WebApps and create/renew admin certificates to be used for login when WebADM is configured in PKI mode.
Import Objects: Batch import LDAP objects from LDIF and CSV files.
Perform Batch Operations: Enable batch (mass) object actions on search results. This role provides the recursive deletion of LDAP subtrees too.
Unlock WebApp Access: Provide one-time access for WebApp configured with access locking.
Manage License File: Install new licenses on the server from the WebADM Admin Portal.

The above role features should be used to restrict WebADM management options for delegated administrators but should not be considered for hard security limitations. LDAP ACL rights must also be setup accordingly!

Application Rights

The AdminRole object provides full control over which application operations and features are allowed for the delegated administrators. Any registered application like OpenOTP or the Self-Services provides a list of role-based authorizations which can also be assigned to an AdminRole.

The role-based permissions are per-application and their documentation is not in the scope of this document. Check the online documentation for your registered applications for details.

WebADM LDAP MountPoints

MountPoints are containers in the LDAP tree that include objects and child containers (i.e. the entire tree structure) from another LDAP server. The objects are not physically present in the main tree structure. Instead, WebADM connects at runtime to an external LDAP and renders its contents as if the data were stored in the mounting context.

MountPoints are LDAP objects that hold LDAP connection parameters. WebADM connects to a remote LDAP using these parameters. Once connected, WebADM retrieves the remote LDAP tree structure and renders it on the main tree. The rendering location, or namely the mounting point, is specified inside the MountPoint object.

All MountPoints must be stored in the same container (specified in the WebADM configuration file) to be read by WebADM at start-up.

WebADM provides a virtual DN notation for accessing objects in mounted LDAP trees. This notation concatenates the MountPoint DN (of the main LDAP) with the real DN in the mounted LDAP and works with all the pages having DN inputs. You can check the virtual DN when editing an object in a mounted LDAP.

The MountPoint supports the following settings:

Mount DN: The local LDAP tree node where the mounted LDAP tree should be mounted.
Host Name: The hostname or IP address of the mounted LDAP server.
Port Number: The LDAP port number of the mounted LDAP server.
Connection Type: The connection type used to connect the mounted LDAP server.
Allowed connection types are None (no encryption), SSL and TSL.
Tree Base: The tree base on the mounted LDAP server.
Login DN: The DN used to bind the mounted LDAP server.
This account must have write permissions on the mounted LDAP server. An empty login DN means anonymous LDAP bind.
Login Password: The password corresponding to the login DN.
Client Certificate File: The client certificate if the mounted LDAP server requires certificate-based client authentication.
Client Certificate Key File: The certificate key corresponding to the client certificate.

WebADM LDAP Domains

WebADM Domains are used by the registered WebADM applications to identify a user with a username, a password and a domain name. The domain objects establish the relationship between a domain name and an LDAP tree base. Also, when an application wants to obtain an LDAP user DN corresponding to the provided login information, it will use the domain tree base to build the LDAP search.

All Domains must be stored in the same container (specified in the WebADM configuration file) to be read by WebADM at start-up.

A WebADM Domain object supports the following settings:

User Search Base: The tree base corresponding to the domain and to be used in the user LDAP searches.
Group Search Base: The tree base to be used in the LDAP group searches.
If not specified, it defaults to the Tree DN. This setting will be ignored if WebADM is configured to use direct groups only.
Domain Name Aliases: A comma-separated list of aliases for the Domain name. Setting multiple names for a single Domain can be useful in the following scenarios:
- You want to enable both ActiveDirectory, NetBIOS and DNS domains naming for your integrations (ex. MYCOMPANY and mycompany.com).
- You use ActiveDirectory User Principal Names (UPNs). In this case, you can create a Domain alias corresponding to the users' UPN suffix.

The Domain User Search Base can be set to a container inside a mounted LDAP or the LDAP mount point DN itself (see MountPoints). This is a very convenient way to assign a domain to the users of another LDAP server.

The WebADM Domains are not the same thing as the LDAP Domain containers (example: dc=myobject). LDAP Domain containers (DC objects) are generic containers like Organizations or Organizational Units. Whereas WebADM Domains are objects of type webadm_config_object such as the OptionSets, MountPoints or Clients and contain some settings.

A WebADM Domain object supports the following user access policy settings:

Allowed Groups: Mandatory LDAP group(s) the domain users must belong to (in order to be considered as part of the domain). If set, users must be a member of at least one of the listed groups.
Excluded Groups: Exclusion LDAP group(s) the domain users must not belong to. If set, users must not be a member of the listed groups.
Allowed Addresses: Required network address(es) with netmask the domain must be accessed from. If set, users must be located in at least one of the listed networks (ex. 192.168.1.0/24).
Excluded Addresses: Excluded network address(es) with netmask the domain must not be accessed from. If set, users must not be located in any of the listed networks.
Allowed Locations: Required country code(s) the domain must be accessed from. If set, users must be located in at least one of the listed countries.
Excluded Locations: Excluded country code(s) the domain must not be accessed from. If set, users must not be located in any of the listed countries.
Allowed Hours: If set, the domain can be used only during the specified week hours.
Excluded Hours: If set, the domain cannot be used during the specified week hours.

Locations and Hours should set graphically using the Edit buttons on the right side.

A WebADM Domain object supports the following user access policy settings:

Allowed WebApps / Web Services: List of applications with which the domain is used.
By default, a domain works with all registered applications (Web Applications and Web Services).

WebADM Client Policies

WebADM Client Policies allow you to configure various settings for a specific client application consuming OpenOTP/Spankey web services, RCDevs Identity Provider, WebApps, and more. The concept of Client Policies makes the WebADM framework very powerful for designing access policies, constraints, and conditions applied to a client application or subset of systems.

Examples of constraints and settings include:

Time constraints;
Contact signature constraints;
Domain constraints;
LDAP attribute constraints;
Authentication settings and more...

Refer to the dedicated Policies & Conditional Access documentation for more information on Client Policies.

Log Viewer

The WebADM SQL logs are accessible from the Databases menu. By default, WebADM provides the following logs:

The Admin Logs: Contains all the actions performed by administrators in the WebADM Administrator Portal. It also contains all operations performed via the WebADM Manager interface.
The WebApp Logs: Contains all the actions reported by the WebApps registered in WebADM.
The Web Services Logs: Contains all the actions reported by the Web Services registered in WebADM.
The Alert Log: Contains all the error events reported by the Web Applications and Web Services.

Important: If you define an OptionSet with a Tree Base restriction, the same restriction will apply to the log entries to be displayed in the log viewer. So the administrators will only see the user action logs corresponding to user DNs under their own scope of visibility.

By default, all log entries found in the WebADM logs database are shown. If the number of logs is large, you can create log filters to narrow down the number of logs shown on the screen.

Creating Log Filters

You can create filters with different criteria. There are a number of filters types that can be combined with operators and the searched value to produce accurate filtering results. You can also filter the logs by time, administrator names, session IDs, application names...
You can click the blue links in the log items to generate automatic filters.

Log Display Options

By default, all log entries found in the WebADM logs database are shown. If the number of logs are large, you can narrow down the number of logs shown on the screen. You can control the number of visible logs in the area using:

The Retrieve last value controls the number of last log entries retrieved from the logs database.
The Per page results value controls the number of log entries shown per page.
The log results are paginated, and you can switch page with the links at the bottom right of the page.

Log Result Actions

A number of log result actions is available to you.

The Delete Selected deletes the logs selected by checking the checkbox next to the log entry in the log result list.
The Export (CSV) link exports the selected logs to comma separated value text (CSV) file. You can save this file and view it in the application of your choice.
The Statistics (CSV) link creates comma separated value text (CSV) statistics of the selected log column. You can select the column by checking the checkbox in the appropriate column title in the log result list.
You can define the number of entries in the statistics with the Display First value.
You can get statistics grouped by time steps with the Group By value.

Pruning the Log Database

In time, the log database grows, and you have to prune it. Enter the pruning time values in the data entry fields press the Clean button to delete logs older than specified from the log database.

Source Map Viewer

With the log viewer, you can graphically draw your current selection of user accesses on a world map with the Draw Source Map button.

Localized Messages Editor

The WebADM localized messages editor allows configuring message templates for the registered applications in different languages. There are two ways to configure WebADM applications localized messages.

You can review all the messages from all the applications using the messages editor accessible from the Databases menu.
You can go through application configurations, locate the message templates and click the Localized buttons to edit the messages in other languages.

The list of supported languages is configurable in the WebADM main configuration file (conf/webadm.conf).

Hardware Inventory Browser

WebADM includes an inventory subsystem to be used by the registered applications like OpenOTP to store and retrieve inventoried data per-reference. The inventory is intended to ease the management of large amounts of Hardware resources like OATH OTP Tokens. For example, OpenOTP Hardware Token's registration is also possible by simply entering the Hardware Token's serial number, provided that the Token has previously been inventoried in WebADM.

The inventory is accessible through the Database WebADM menu and provides WAPI functions to let the registered applications use the inventory functionalities. The inventoried data are encrypted in the database with the same AES master key which is used to encrypt LDAP user data. Like for WebADM user data, there is per-item encryption and the inventory Type and Reference fields are used as part of the encryption process. Modifying one item's reference also invalidates the encrypted item's data.

Exported inventories are extracted with encrypted data by default. Only the inventory files provided by RCDevs and its partner Vendors are provided without the WebADM per-item AES encryption to allow the inventory import on the customer's inventory system.

The inventory provides an option to batch re-encrypt inventoried data in the event where the WebADM AES master key gets changed.

The inventory provides easy filter-based item search functionalities and allows administrators to flag items as Valid, Lost, Broken or Expired.

Extending the LDAP Schema

WebADM relies on its own LDAP object classes and attributes, which form the WebADM schema. This schema information must be included in the LDAP server using WebADM and its applications. During the WebADM graphical setup, the schema of your LDAP server is extended to include the necessary RCDevs schema information (see the WebADM Installation Guide for details).

When you create a MountPoint, the LDAP in the mounted LDAP server must also be extended. WebADM checks if the LDAP schema is extended and proposes to add the extension if not present. Note that with OpenLDAP, the WebADM schema file must be added to the server configuration manually. You can extend the mounted LDAP schema by editing the MountPoint object or the LDAP container where the remote LDAP is mounted. The schema extension link is included in the contextual object action box.

For Active Directory, it is not mandatory to extend the schema required by the WebADM framework. WebADM can work with an AD that does not have the schema exetension and simultaneously work with OpenLDAP or Novell with schema extension. If the RCDevs object classes and attributes are available on the destination LDAP infrastructure, WebADM will default to using them. If the schema extension is not available on AD, for example, WebADM defaults to using the bootableDevice objectClass (refer to the LDAP schema dedicated documentation).

If you choose to extend the schema in Active Directory, WebADM must be connected to a Domain Controller with the schema master role for the extension to succeed.

The RCDevs schema includes OIDs registered at IANA under RCDevs' Private Enterprise Numbers 34617.

Refer to the LDAP Schema Concerns documentation for more information on LDAP schema extensions.

Managing Applications

WebADM registered applications provide their own configuration schemas to the system. The application configurations are accessible from the WebADM Applications menu.
WebADM provides a very high-level interface for managing very complex application configurations. WebADM relies on XML schema files, which transparently make the mapping between the application configuration requirements and the graphical configuration editors. The schema files are provided with the applications and should not be edited.

To set up an application in WebADM:

Install the application on the system with its self-installer.
Enter WebADM and navigate to the Applications menu.
Click to register the application.
{{< figure src="../72.webp" class="img100 center" width="800" height="369" >}}

Figure 71. Register Application
Click to configure the application.
{{< figure src="../73.webp" class="img100 center" width="800" height="369" >}}

Figure 72. Configure Application
Save the settings and your application is now immediately operational.

User Application Settings

The default application's settings are defined as described just before. Yet, some settings can be re-defined per user or groups. WebADM processes the settings in the following order:

Application level settings are applied first. They are considered as default settings.
Group settings (if any) are applied. If the user is a member of multiple groups, the group's settings are merged.
{{< note title="Note" >}}User groups and group settings are cached for 5 minutes in order to optimize group searches and user setting resolutions. This has the side effect that user groups and group settings' changes may be delayed for a maximum time of 5 minutes when used by WebApps and Web Services.{{< /note >}}
User settings (if any) are applied.
Web Service Client settings are applied if the client requesting the service matches a Client object name.
Request settings (if any) are applied. The Web Service's API provides a Settings SOAP field to dynamically pass user settings to the WebADM services.

That means that the user settings have priority over the group settings which have themselves priority over the application default settings, etc...

To add settings to a user or group (when no setting is defined yet), select the WebADM Settings in the Add Attribute action for the user. If the user/group is not extended with the webadmAccount object class, or the group is not extended with the webadmGroup object class, you must extend it first with the Add Extension action to be able to add settings.

To modify the user/group settings in a webadmAccount/webadmGroup object, edit the object and click the links in the information box (at the top middle of the editorial page), or click the Edit WebADM Settings button in the object attribute list.

{{< figure src="../74.webp" class="img100 center" width="800" height="676" >}}
{{< figure src="../74a.webp" class="img100 center" width="800" height="668" >}}
{{< figure src="../74b.webp" class="img100 center" width="800" height="668" >}}
{{< figure src="../74c.webp" class="img100 center" width="800" height="434" >}}

Figure 73. User Settings Editor

Using the Manager Interface

The Manager interface provides access to some WebADM user management functions and operations exported by your registered applications. The Manager also allows external systems such as Web portals to remotely trigger user management operations and actions from the network.

The user management functions provide LDAP operations such as object creation, update, removal, WebADM settings and data management, etc... The method names for internal management functions are in the form of Manager_Method.

The operations exported by the registered applications provide access to any features which are accessible from the application actions in the Admin Portal. The method names for application-exported functions are in the form of Application.Manager_Method.

The interface communication protocol is based on the JSON-RPC v2.0 specification. You can find the JSON-RPC specification at http://jsonrpc.org/spec.html.

You can go to the Manager Interface page in the WebADM Admin menu to have a full listing of the supported Manager functions and parameters. You can then navigate between applications to get the Manager functions supported by a specific registered application.

The Manager API requires authentication and a WebADM administrator account must be provided to access the interface. The authentication mechanism which is enforced is always the same as the mechanism configured for the WebADM Admin Portal (i.e. The auth_mode setting in the webadm.conf file).

{{< note title="Note" >}}
Any LDAP permission or OptionSet restriction configured in WebADM will be enforced within the Manager interface. Administrators have also the same level of access in the Manager as they have in the Admin Portal.
{{< /note >}}

With DN login mode, the administrator DN and password must be provided in the HTTP-Basic Authorization header.
With UID login mode, the administrator user ID and password must be provided in the HTTP-Basic Authorization header.
With PKI login mode, the administrator's user certificate must be used for establishing the HTTPs connection to the interface and the administrator password must be provided in the HTTP-Basic Authorization header.

A connection to the Manager automatically creates an Administrator session in WebADM for processing the requested methods. The Manager responses return a session cookie called WEBADMMANAG in the response headers. You can pass the session cookie in the next Manager requests to avoid starting new sessions.

Note that the Manager sessions have a short expiration time and are automatically closed after 10 seconds of inactivity. Yet, you can force the closure of the session by passing the “Connection: close” header to the requests.

The Manager interface is accessible at the URL: https://yourserver/manag/.

Look at Appendix D for some simple examples of function calls using the PHP language to use the Manager Interface.

Installing WebApps and Web Services

WebADM has been designed to ease as much as possible the installations, upgrades and removal of applications (WebApps and Web Services).

To install a new RCDevs application (WebApp or Web Service) in WebADM, proceed as follows:

Get the application self-installer package from the RCDevs website.
Copy it to your Linux server running WebADM.
Uncompress it with the command gunzip application-x.x.x.sh.gz
Set installer as UNIX executable with the command chmod 755 application-x.x.x.sh.
Run the self-installer and answer the setup questions with the command ./application-x.x.x.sh.
WebApps application files will be installed in the webapps/ system folder, under a folder having the name of your WebApp.
Web Services application files will be installed in the websrvs/ system folder, under a folder having the name of your Web Service.
Log in WebADM as with a super administrator account.
Navigate to the Applications menu and click the Register button for the new application (see section Applications Administrators for details).
WebADM will create an LDAP configuration object for the new application in the webapps_container for WebApps and in the websrvs_container for Web Services, as defined in the WebADM main configuration file (conf/webadm.conf).

{{< figure src="../75.webp" class="img90 center" width="382" height="452" >}}

Figure 74. Application Registered in LDAP
Click the Configure button for the new application, adjust the application settings and save the settings (see section Applications Administrators for details).
WebADM will update the LDAP configuration object with the new settings.

Important: You do not have to modify any file in the application installation directory! The applications configurations are managed and stored in LDAP by WebADM from the Applications menu only.

To upgrade an application, do not remove the previous version and proceed exactly like for the installation. Read the CHANGELOG and README files to get the list of changes and proceed with the required modifications.

After a WebApp or Web Service upgrade, the application configurations may need to be updated. Log in WebADM and check the installed application status on the homepage or in the Applications menu. If a configuration update is required, click the Not Configured button to update the configuration and save the application settings again.

Embedding a WebApp

By default, WebApps are accessible from the WebApps portal at the URL http://yourserver/webapps/. And a specific WebApp (mywebapp) can be accessed at the URL http://yourserver/webapps/mywebapp.

You can embed a WebApp directly into a part of your website in an HTML iFrame or HTML Object.
Insert the following code into your website to embed a WebApp directly into your website.

<object data="https://myserver/webapps/mywebapp?inline=1" />

Replace myserver and mywebapp with your WebADM server address and the WebApp name.

The parameter inline=1 informs WebADM that the WebApp is embedded. WebADM will skip the HTML headers, footers and stylesheets. It will stream only the HTML BODY content for the WebApp.

Clustering

WebADM has been entirely designed for clustering. A WebADM system can be divided into more than one server for failover or load-balancing purposes. A WebADM server can be dedicated to one specific task such as administrator portal, WebApp server or Web Services servers. Moreover, multiple servers can be assigned the same task.

Please look at the WebADM High Availability Guide for Cluster installations.

For a clustered configuration, you mainly have to respect the following conditions:

All the servers of the cluster must use the same session manager at one moment.
There can be multiple session managers for failover but all the systems must be configured to work with the same session manager at one time.
All the servers of the cluster must use the same PKI server (as for session manager). This is mandatory to keep the Certificate Authority consistent.
All the servers must have basically the same configurations and especially must use the same LDAP encryption key.

The session manager (Redis) and PKI server (RSignd) are very high-performance systems, multithreaded and written in C. Redis components do not call external network services such as LDAP or SQL servers and can also handle very high numbers of requests. Rsignd need LDAP and SQL server in order to store certificates.

Several servers can be configured to play the same role without any consequence because the application configurations and user information are stored in LDAP (which is a network service). So as long as all the clustered servers are connected to the same services (or multiple real-time replicated services) the whole system should not be impacted by the clustering.

Several Web Services servers can be accessed at the same time and client requests can even go randomly to any of the servers without a problem (as long as all the servers use the same session manager). For example, an OpenOTP SMSTOP login request can come to Server1, and the OTP challenge-response request can come to Server2. As Server1 and Server2 use the same session manager, the second request will be recognized by Server2 and part of a valid session.

In a clustered system, all the WebADM servers are automatically informed when an application configuration is changed by an administrator, and then, all the servers automatically refresh their configuration caches.

{{< warning title="Warning" >}}Starting from WebADM version 1.4.2, any high availability and clustering feature require an RCDevs Enterprise license. Without a valid license file, the HA and cluster features are automatically disabled.{{< /warning >}}

LDAP Permissions

WebADM Proxy User

There are two things to be considered in order to implement fine-grained LDAP permission for WebADM and its applications.

WebADM Proxy user permissions: This system user is used by WebADM to access and manipulate the required LDAP resources.
Administrator users permissions: These accounts login to the Admin portal in order to manage LDAP resources and registered applications.

The proxy user is required by WebADM to access LDAP resources (ex. application configuration, users, groups...) out the permissions of an Admin user's session.

The proxy user must have at least read-only permissions on the whole LDAP tree. It is used by the WebApps and Web Services such as OpenOTP and also requires some attribute write permissions as described below, over the trees where are stored the LDAP users.

By default, and for simplification, it is recommended to use an Administrator account of the LDAP directory as WebADM Proxy user.

If you need to implement finer LDAP access rights then:

The proxy user needs to perform a wide LDAP search and reads. It also requires read-only permissions to the WebADM LDAP configurations (i.e. configured containers) and to the user Domains subtrees.
The proxy user needs to do some write operations to a few LDAP attributes because it needs to store dynamic application user data into the users.

In some circumstances, the Proxy user will also need to write an application setting on the users and groups. The following attributes are part of the WebADM LDAP schema and need Proxy user write permissions:

webadmData: is the attribute where the applications store the user data (ex. OpenOTP enrolled Token states).
webadmSettings: is the attribute where WebADM stores user-specific settings (ex. per-user OTP policy).

If you use WebADM Self-Services and depending on what you allow users to do within the self-service applications, then WebADM Proxy user may need some additional permissions: Ex. if you want users to reset their LDAP password, set their mobile numbers or email addresses, then the Proxy user will need to have write permissions to the corresponding LDAP attributes.

In general, it is recommended to implement Proxy user write access to the following attributes:

webadmData (dynamic and encrypted application data)
webadmSettings (only if Self-Services are used to configure account settings)
mail (only if Self-Services are used to set email addresses)
mobile (only if Self-Services are used to set mobile numbers)
preferredLanguage (only if Self-Services are used to set user language)
userPassword or unicodePwd for Windows AD (only if Self-Services are used to set user password)

Administrators

When an administrator logs in the WebADM Admin Portal, he always accesses and manages the LDAP resources under his own LDAP permissions. This means the user/group/configuration management permissions are enforced at the LDAP level. For example, a Windows AD Domain Administrator will be able to manage users and groups.

{{< note title="Note" >}}
To be able to log in WebADM, an LDAP user must be either a Super Administrator (configured in super_admins in webadm.conf) or another Administrator (delegated administrator). Another Administrator is any admin users which is part of a WebADM Admin Role.
{{< /note >}}

Using Custom SSL Certificates

The WebADM setup script automatically creates a self-signed CA certificate for the PKI server and a self-signed SSL certificate which is used by both the WebADM's HTTP and RSignd services. The SSL certificate file is stored in /opt/webadm/pki/webadm.crt and the corresponding key file is stored in /opt/webadm/pki/webadm.key.

Yet, in WebADM it is possible to use another (external) SSL certificate. This is useful if you need your WebADM HTTP services to operate under a trusted certificate. To use a custom SSL certificate, you need the certificate and key files from your CA vendor in PEM format. The certificate file may optionally contain the intermediate CA certificate list (concatenated after the PEM data). The custom certificate file must be stored in /opt/webadm/pki/custom.crt and the key file must be stored in /opt/webadm/pki/custom.key. The custom certificate will be used by the WebADM Admin Portal and the WebApps only. WebADM Web services will still operate with the self-signed SSL certificate. You must also not remove the webadm.crt and webadm.key files. These certificate files are still used by RSignd and your SOAP Web services.

Note: If you configure a CA certificate trust for your Web services' integrations (ex. OpenOTP integrations plugins), the trusted CA certificate is always the WebADM's internal PKI certificate which you can download under the WebADM Admin menu.

Appendix A: Sample webadm.conf File

#
# WebADM Server Configuration
#

# Administrator Portal's authentication method.
# - PKI: Requires client certificate and login password.
# - UID: Requires domain name, login name and password.
# - DN: Requires login DN and password.
# - OTP: Like UID with an OTP challenge.
# - U2F: Like UID with a FIDO-U2F challenge.
# - MFA: Like UID with both OTP and FIDO-U2F challenge.
# Using certificates is the most secure login method. To use certificate login,
# you must log in WebADM and create a login certificate for your administrators.
# The UID mode requires a WebADM domain to exist and have its User Search Base
# set to the subtree where are located the administrator users. When using UID 
# and if there is no domain existing in WebADM, the login mode is automatically
# forced to DN. You will also need to log in with the full user DN and set up
# a WebADM domain to be able to use the UID login mode.
admin_auth UID

# Show the registered domain list when admin_auth is set to UID, OTP or U2F.
# And set a default admin login domain when auth_mode is set to these methods.
list_domains Yes
#default_domain "Default"

# Manager API's authentication method. Only UID, PKI and DN are supported here.
# If you set the admin_auth with multi-factor (PKI, OTP or U2F), then you must
# either use manager_auth PKI or UID with a list of allowed client IPs.
#manager_auth UID
#manager_clients "192.168.0.10","192.168.0.11"

# User level changes the level of feature and configuration for all applications.
# WebADM proposes three levels: Beginner, Intermediate and Expert. The default
# level (Expert) is recommended as it provides access to all the RCDevs features.
user_level Expert

# If your LDAP directory is setup with a base DN (ex. dc=mydomain,dc=com on AD),
# you can optionally set the base_treebase suffix and omit the suffix in other
# LDAP configurartions like proxy_user, super_admins and containers.
#ldap_treebase "dc=mydomain,dc=com"

# The proxy user is used by WebADM for accessing LDAP objects over which the
# admin user does not have read permissions or out of an admin session.
# The proxy user should have read permissions on the whole LDAP tree,
# and write permissions on the users/groups used by the WebApps and WebSrvs.
# The use of a proxy user is required for WebApps and WebSrvs.
# With ActiveDirectory, you can use any Domain Administrator DN as a proxy user,
# which should look like cn=Administrator,cn=Users,dc=mydomain,dc=com.
proxy_user     "cn=webadm,dc=WebADM"
proxy_password "Password1234"

# Super administrators have extended WebADM privileges such as setup permissions,
# additional operations and unlimited access to any LDAP encrypted data. Access
# restriction configured in the WebADM OptionSets and AdminRoles do not apply to
# super admins. You can set a list of individual LDAP users or LDAP groups here.
# With ActiveDirectory, your administrator account should be is something like
# cn=Administrator,cn=Users,dc=mydomain,dc=com. And you can replace the sample 
# super_admins group on the second line with an existing security group.
super_admins "cn=admin,o=root", \
	     "cn=super_admins,dc=WebADM"

# LDAP objectclasses
container_oclasses      "container", "organizationalUnit", "organization", "domain", "locality", \
                        "country", "openldaprootdse", "treeroot"
# user_oclasses is used to build the LDAP search filter with 'Domain' auth_mode.
# If your super admin user user does not have one of the following objectclasses,
# add one of its objectclasses to the list.
user_oclasses           "user", "account", "person", "inetOrgPerson", "posixAccount"
group_oclasses          "group", "groupOfNames", "groupOfUniqueNames", "groupOfURLs", "posixGroup"
# With ActiveDirectory 2003 only, you need to add the 'user' objectclass to the
# webadm_account_oclasses and the 'group' objectclass to the webadm_group_oclasses.
webadm_account_oclasses "webadmAccount"
webadm_group_oclasses   "webadmGroup"
webadm_config_oclasses  "webadmConfig"

# LDAP attributes
certificate_attrs       "userCertificate"
password_attrs          "userPassword", "unicodePwd", "sambaNTPassword"
uid_attrs               "uid", "samAccountName", "userPrincipalName"
member_attrs            "member", "uniqueMember"
memberof_attrs          "memberOf", "groupMembership"
memberuid_attrs         "memberUid"
language_attrs          "preferredLanguage"
mobile_attrs            "mobile"
mail_attrs              "mail"
webadm_data_attrs       "webadmData"
webadm_settings_attrs   "webadmSettings"
webadm_type_attrs       "webadmType"
webadm_voice_attrs      "webadmVoice"

# Set the LDAP container required by WebADM to store its configuration objects.
config_container "dc=WebADM"

# You can alternatively configure each configuration container independently.
#domains_container "dc=Domains,dc=WebADM"
#clients_container "dc=Clients,dc=WebADM"
#devices_container "dc=Devices,dc=WebADM"
#webapps_container "dc=WebApps,dc=WebADM"
#websrvs_container "dc=WebSrvs,dc=WebADM"
#adminroles_container "dc=AdminRoles,dc=WebADM"
#optionsets_container "dc=OptionSets,dc=WebADM"
#mountpoints_container "dc=MountPoints,dc=WebADM"

# You can set here the timeout (in seconds) of a WebADM session.
# Web sessions will be closed after this period of inactivity.
# The Manager Interface cookie-based sessions are disabled by default.
admin_session 900
manager_session 0
webapps_session 600

# You can set here the WebADM internal cache timeout. A normal value is one hour.
cache_timeout 3600

# Application languages
languages "EN","FR","DE","ES","IT","FI"

# WebADM encrypts LDAP user data, sensitive configurations and user sessions with
# AES-256. The encryption key(s) must be 256bit base64-encoded random binary data.
# Use the command 'openssl rand -base64 32' to generate a new encryption key.
# Warning: If you change the encryption key, any encrypted data will become invalid!
# You can set several encryption keys for key rollout. All the defined keys are used
# for decrypting data. And the first defined key is used to (re-)encrypt data.
# Two encryption modes are supported:
# Standard: AES-256-CBC (default)
# Advanced: AES-256-CBC with per-object encryption (stronger)
encrypt_data Yes
encrypt_mode Standard
encrypt_hsm  No
encrypt_key  "cq19TEHgHLQuO09DXzjOw30rrQDLsPkT3NiL6l3BH2w="

# Hardware Cryptography Module
# Yubico YubiHSM and SCHSM are currently supported for hardware encryption.
# Up to 8 HSM modules can be concurrently attached to the server.
#hsm_model YubiHSM
#hsm_keyid 0
#hsm_pincode XXXXXX

# The data store defines which back-end is used for storing user data and settings.
# By default WebADM stores any user and group metadata in the LDAP objects. By setting
# the data_store to SQL, these metadata are stored in a dedicated SQL table.
# LDAP remains the preferred option because it maximizes the system consistency.
# SQL should be used only if you need read-only LDAP access for the proxy_user.
data_store LDAP

# The record store defines which back-end is used to store SpanKey records.
# Choose SQL to store records in the database and NAS to store on a shared NAS folder. 
# With NAS, the store_path must be configured and accessible from all cluster nodes.
record_store SQL
#record_path "/mnt/records"

# The group mode defines how WebADM will handle LDAP groups.
# - Direct mode: WebADM finds user groups using the memberof_attrs defined above.
#   In this case, the group membership is defined in the LDAP user objects.
# - Indirect mode: WebADM finds user groups by searching group objects which contain
#   the user DN as part of the member_attrs.
# - Auto: Both direct and indirect groups are used.
# - Disabled: All LDAP group features are disabled in WebADM.
# By default (when group_mode is not specified) WebADM handles both group modes.
group_mode Auto

# LDAP cache increases a lot of performances under high server loads. The cache limits
# the number of LDAP requests by storing resolved user DN and group settings. When
# enabled, results are cached for 300 secs.
ldap_cache Yes

# LDAP routing enables LDAP request load-balancing when multiple LDAP servers are
# configured in servers.xml. You should enable this feature only if the LDAP server
# load becomes a bottleneck due to a big amount of users (ex. more than 10000 users).
#ldap_routing No

# You can optionally disable some features if you run multiple WebADM servers with
# different purposes. For example, if you don't want to provide admin portal on an
# Internet-exposed WebApps and WebSrvs server.
# By default, all the functionalities are enabled.
enable_admin Yes
enable_manager Yes
enable_webapps Yes
enable_websrvs Yes

# Enable syslog reporting (disabled by default). When enable, system logs are sent
# to both the WebADM log files and syslog.
#log_debug No
#log_mixsql No
#log_syslog No
#syslog_facility LOG_USER
#syslog_format CEF

# Alerts are always recorded to the SQL Alert log. Additionally, when alert_email
# or alert_mobile is defined, the alerts are also sent by email/SMS.
#alert_email "me@mydomain.com"
#alert_mobile "+33 12345678"

# Alert users via email when a login certificate or ActiveDirectory domain password
# is near expiration. The templates are defined in ldap_expire_xxx and cert_expire_xxx.
user_warning Yes

# Protect WebADM against bruteforce attacks on the WebApps by blacklisting source IPs
# for 20 seconds after 5 failed login attempts.
ip_blacklist Yes

# You can publish WebADM applications and OpenOTP mobile endpoint over Internet using
# a reverse proxy (WAF) or RCDevs WebADM Publishing Server (WAProxy).
# Set the IP address(es) of your reverse-proxy or WAProxy server(s). WebADM expects
# the HTTP_X_FORWARDED_FOR and HTTP_X_FORWARDED_HOST headers from reverse proxies!
# Use 'waproxy_proxies' ONLY if you are using RCDevs WAProxy as reverse-proxy!
#reverse_proxies "192.168.0.100", "192.168.0.101"
#waproxy_proxies "192.168.0.102"
# The 'public_hostname' is mandatory to let WebADM know your public endpoints' URLs.
# Use the public DNS name of your reverse proxy or WAProxy server without a scheme.
# The setting used to be named 'waproxy_pubaddr' in WebADM versions before v2.3.12.
#public_hostname "www.myproxy.com"

# Check for new product versions and license updates on RCDevs' website.
# These features require outbound Internet access from the server.
cloud_services Yes

# WebApps theme (default or flat)
# Comment the following line to disable the default theme.
webapps_theme "default"

# End-user message templates
# The following variables are available: %USERNAME%, %USERDN%, %USERID%, %DOMAIN%, %APPNAME%
# Additional variables are available depending on the context: %APPNAME%, %APPID%, %TIMEOUT%, %EXPIRES%
app_unlock_subject "Unlocked access to %APPNAME%"
app_unlock_message "Hello %USERNAME%,\r\n\r\nYou have a one-time access to the %APPNAME%.\r\nYour access will automatically expire %EXPIRES%."
ldap_expire_subject "Login password near expiration"
ldap_expire_message "Hello %USERNAME%,\r\n\r\nYour login password will expire %EXPIRES%.\r\nPlease reset your password before expiration!\r\n\r\nRegards"
cert_expire_subject "Login certificate near expiration"
cert_expire_message "Hello %USERNAME%,\r\n\r\nYour login certificate will expire %EXPIRES%.\r\nPlease renew your certificate before expiration!\r\n\r\nRegards"

# Personalization options
# You can customize your organization's name, logo file and website URL.
# The logo file must be a PNG image under conf/ with a size of 100x50 pixels.
#org_name "RCDevs SA"
#org_logo "rcdevs.webp"
#org_site "http://www.rcdevs.com/"
#org_from "noreply@rcdevs.com"

# Misc options
#treeview_width 300
#treeview_items 1500
#default_portal Admin
#ldap_uidcase No
#ntp_server "myserver"

Appendix B: Sample servers.xml File

<?xml version="1.0" encoding="UTF-8" ?>

<Servers>

<!--
******************************************
***  WebADM Remote Server Connections  ***
******************************************

You can configure multiple instances for each of the following servers.
At login, WebADM will try to connect the configured servers in the same
order they appear in this file and uses the first one it successfully 
establishes the connection to. If the server connection goes down, it
will automatically failover to the next configured server.

Any special characters must be encoded in XML compliant format.
At least one LDAP server and one SQL server is required to run WebADM.
Supported servers: OpenLDAP, Active Directory, Novell eDirectory, 389.

Allowed LDAP parameters are:
 - name: server friendly name
 - host: server hostname or IP address
 - port: LDAP port number
   default and TLS: 389
   default SSL: 636
 - encryption: connection type
   allowed type are NONE, SSL and TLS
   default: 'NONE'
 - ca_file: Trusted CA for SSL and TLS
 - cert_file: client certificate file
 - key_file: client certificate key
 - sasl: SASL bind options separated by spaces
-->

<LdapServer name="LDAP Server"
	host="localhost"
	port="389"
	encryption="NONE"
	ca_file=""
	sasl="" />

<!--
<LdapServer name="LDAP Server 2"
	host="remotehost"
        port="389"
	encryption="TLS"
	ca_file="" />
-->

<!--
SQL servers are used for logs; message localizations and inventories.
Supported servers: MySQL5, MySQL8, PostgreSQL, MSSQL, Sybase, Oracle, SQLite.

Allowed SQL parameters are:
 - type: MySQL5, MySQL8, MariaDB, PostgreSQL, MSSQL, Sybase, Oracle or SQLite.
 - name: server friendly name
 - host: server hostname or IP address
 - port: SQL port number (depends on server type)
 - user: database user
 - password: database password
 - database: database name
 - encryption: connection type allowed type are NONE, SSL and TLS 
 - ca_file Trusted CA for SSL and TLS
 - cert_file: client certificate file
 - key_file: client certificate key
 
With SQLite, only the 'database' must be set and other parameters are
ignored. The database is the full path to an SQLite DB file where WebADM
has full write access. 

With Oracle, you can optionally use TNS names. If the 'tnsname' is set
then the 'host' and 'port' parameters are ignored and a tnsnames.ora 
file must exist under the conf/ directory.
-->

<SqlServer name="SQL Server"
	type="MySQL"
	host="localhost"
	user="webadm"
	password="webadm"
	database="webadm"
        encryption="NONE" />

<!--
A session server is required for web services using sessions
such as OpenOTP. You can specify one or more SQL servers here.
The session server is included in WebADM. So you can keep the
default settings here.
Using SSL/TLS encryption requires port 4001 and may slow down 
your WebADM execution by a foctor of 20%.
WARNING: TLS support is currently broken with PHPRedis!
-->

<SessionServer name="Session Server"
	host="localhost"
	port="4000"
	encryption="NONE"
        secret="secret" />

<!--
A PKI server (or CA) is required for signing user certificates.
The RSign PKI server is included in WebADM. So you can keep the
default settings here.
-->

<PkiServer name="PKI Server"
	host="localhost"
	port="5000"
	secret="secret" />

<!--
HTTP proxy servers can be used by WebADM for connecting
remote Web services and version checking.
-->

<!--
<ProxyServer name="HTTP Proxy"
	host="proxy"
        port="8080"
        user=""
        password=""
	ca_file="" />
-->

<!--
SMTP mail servers can be used by WebADM for sending emails.
If no server is specified, WebADM will use the local mailer
in /usb/sbin/sendmail to send emails.
-->

<!--
<MailServer name="SMTP Server"
        host="localhost"
	port="25"
	user=""
	password=""
	encryption="NONE"
	ca_file="" />
-->

</Servers>

Appendix C: Sample rsignd.conf File

#
# WebADM PKI Server Configuration
#

# Log file
logfile /opt/webadm/logs/rsignd.log
pidfile /opt/webadm/temp/rsignd.pid

# Default validity period for new certificates (in days)
# The CSR signing requests may set the validity period.
user_cert_validity 365
client_cert_validity 1825
server_cert_validity 3650

# Certificate and key used for the SSL listener
rsignd_cert /opt/webadm/pki/webadm.crt
rsignd_key /opt/webadm/pki/webadm.key

# Path CA certificate files and serial
ca_cert /opt/webadm/pki/ca/ca.crt
ca_key /opt/webadm/pki/ca/ca.key
ca_serial /opt/webadm/pki/ca/serial

# Serial number format (hex or dec)
serial_format hex

# Set to yes if the CA or RSignd private keys requires a decryption password.
# PEM passwords will be prompted at WebADM startup.
ca_password no
rsignd_password no

# HSM certificate authority (CA)
# The HSM model and PIN code are confirgured in webadm.conf.
hsm_ca no
hsm_keyid 0

#
# Directory or file containing trusted CA certificates (in PEM format)
# After adding a new certificate, type a "make" in the "trusted_ca_path" 
# to rebuild certificate's hash.
# This is needed for rsignd to read the trusted CA certificates.
# Comment "trusted_path" to disable rsignd certificate's trust restrictions.
trusted_path /opt/webadm/pki/trusted

#
# Client sections
#
# Declare here the Rsign clients with IP addresses or hostnames.
# In cluster mode, the client WebADM server(s) must be defined here!

client {
       hostname localhost
       secret secret
}

#client {
#       hostname remote_server
#       secret secret
#}

Appendix D: Sample Manager Interface Usage

Find below a few simple examples of the use of the WebADM Manager interface. The examples are written in PHP and use the cURL extension to send the JSON-RPC call over HTTP.

Resolve the DN of an existing user.

<?php
$method = 'Get_User_DN';
$params = array(
	'username' => 'test',
	'domain' => 'Default',
);

$request = array(
	'jsonrpc' => "2.0",
	'method' => $method,
	'params' => $params,
	'id' => 0);
$json = json_encode($request);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://localhost/manag/");
curl_setopt($ch, CURLOPT_USERPWD,"default\\admin:password");
curl_setopt($ch, CURLOPT_HTTPHEADER, array("connection: close"));
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
$out = curl_exec($ch);
curl_close($ch);

print_r(json_decode($out));
?>

The manager will return a structure int form:

stdClass Object
(
	[jsonrpc] => 2.0
	[result] => cn=test,o=Root
	[id] => 0
)

Search email for LDAP users with the webadmAccount extension.

$method = 'Search_LDAP_Objects';
$params = array(
	'basedn' => 'o=root',
	'filter' => '(objectclass=webadmaccount)',
	'attrs' => array('mail')
);

Will return:

stdClass Object
(
	[jsonrpc] => 2.0
	[result] => stdClass Object
		(
			[cn=test1,o=Root] => stdClass Object
				(
					[mail] => stdClass Object
						(
							[0] => test1@mycompany.com
						)
				)
	[cn=test2,o=Root] => stdClass Object
				(
					[mail] => stdClass Object
						(
							[0] => test2@mycompany.com
						)
				)
		)
	[id] => 0
)

Set the user mobile number and email address.

$method = 'Set_User_attrs';
$params = array(
	'dn' => 'cn=test,o=root', 
	'attrs' => array('mobile' => array('12345678'), 'mail' => array('test@test.com')),
);

Will return:

stdClass Object 
(
	[jsonrpc] => 2.0
	[result] => 1
	[id] => 0
)

Get the user mobile number and email address.

$method = 'Get_User_attrs';
$params = array(
	'dn' => 'cn=test,o=root', 
	'attrs' => array('mobile', 'mail'),
);

Will return:

stdClass Object
(
	[jsonrpc] => 2.0
	[result] => stdClass Object
		(
			[mobile] => Array
				(
					[0] => 12345678
				)

			[mail] => Array
				(
					[0] => test@test.com
				)

		)

	[id] => 0
)

Set some user application settings.

$method = 'Set_User_Settings';
$params = array(
	'dn' => 'cn=test,o=root', 
	'settings' => array('OpenOTP.LoginMode' => 'LDAPOTP', 'OpenOTP.SecureMail' => false),
);

Will return:

stdClass Object 
(
	[jsonrpc] => 2.0
	[result] => 1
	[id] => 0
)

$method = 'OpenOTP.HOTP_Register';
$params = array(
	'dn' => 'cn=test,o=root',
	'key' => base64_encode(“12345678901234567890”),
	'counter' => 0
);

Will return:

stdClass Object 
(
	[jsonrpc] => 2.0
	[result] => 1
	[id] => 0
)

Create a WebADM-enabled user.

$method = 'Create_LDAP_Object';
$params = array(
				'dn' => 'cn=test_user,o=root',
				'attrs' => array('objectclass' => array('person','inetorgperson','webadmaccount'),
								 'uid' => array('test_user'),
								 'userpassword' => array('password'),
								 'sn' => array('Test User'))
 );

Will return:

stdClass Object 
(
	[jsonrpc] => 2.0
	[result] => 1
	[id] => 0
)

Create an Administrator user and add home to the admin group.

In this example, we send two RPC commands in one single request.

$method = 'Create_LDAP_Object';
$params = array(
				'dn' => 'cn=test_admin,o=root',
				'attrs' => array('objectclass' => array('person','inetorgperson'),
								 'uid' => array('test_admin'),
								 'userpassword' => array('password'),
								 'sn' => array('Test Admin'))
);
$request1 = array(
				 'jsonrpc' => "2.0",
				 'method' => $method,
				 'params' => $params,
				 'id' => 1
);

$method = 'Set_User_Attrs';
$params = array(
				'dn' => 'cn=other_admins,dc=WebADM',
				'attrs' => array('member' => array('cn=test_admin,o=root')),
				'values' => true
);
$request2 = array(
				 'jsonrpc' => "2.0",
				 'method' => $method,
				 'params' => $params,
				 'id' => 2
);

$request = array($request1, $request2);

Will return:

Array
(
	[0] => stdClass Object
		(
			[jsonrpc] => 2.0
			[result] => 1
			[id] => 1
		)
	[1] => stdClass Object
		(
			[jsonrpc] => 2.0
			[result] => 1
			[id] => 2
		)
)

Change a user password.

$method = 'Set_User_Password';
$params = array(
	'dn' => 'cn=test,o=root',
	'password' => 'newpassword'
);

Will return:

stdClass Object 
(
	[jsonrpc] => 2.0
	[result] => 1
	[id] => 0
)

WebADM Administrator Guide

Product Documentation

Product Overview

Files and Folders

WebADM Components

Network Services

HTTP Server

SOAP Server

Session Manager

Watchd Server

PKI Server

Services Start and Stop

Web Portals

The Administrator Portal

The WebApps Portal

The Web Services Portal

Web Services

Web Applications

The Manager Interface

Configuration Files

Other Configurations

Encrypting Configuration Passwords

LDAP Management

Common LDAP Objects

User Accounts

User Groups

Administrative Accounts

Permissions

Certificates

Containers

WebADM Configuration Objects

WebADM AdminRoles

WebADM OptionSets

WebADM MountPoints

WebADM LDAP Domains

WebADM Client Policies

WebADM WebApps and Web Services

WebADM-Specific Attributes

WebADM Settings Attribute

WebADM Data Attribute

Password Attribute

UID Attribute

Certificate Attribute

Language Attribute

Mobile Attribute

Mail Attribute

Voice Attribute

WebADM Config Type Attribute

WebADM LDAP Schema

Creating Objects

Editing Objects

The Contextual Action Box

The Information Box

The Application Box

Object Name

New Attributes

Extensions

Attribute List

Moving / Copying Objects

Exporting / Importing Objects

LDIF Export / Import

CSV Import

Searching for Objects

Batch Search Actions

WebADM OptionSets

WebADM AdminRoles

Basic Permissions

Management Rights

Application Rights

WebADM LDAP MountPoints

WebADM LDAP Domains

WebADM Client Policies

Log Viewer

Creating Log Filters

Log Display Options

Log Result Actions

Pruning the Log Database

Source Map Viewer

Localized Messages Editor

Hardware Inventory Browser