InterSystems IRIS Data Platform 2019.2  /  Security Administration Guide

Security Administration Guide
Using Character-based Security Management Routines
Previous section          
InterSystems: The power behind what matters   

The preferred and recommended way to manage an InterSystems IRIS™ installation is the Management Portal. The portal provides a convenient, browser-based interface for controlling the system. However, to cover those instances when the system cannot be managed this way, InterSystems IRIS also has several character-based routines that collectively provide many of the same functions on the Terminal.
The utilities described in this appendix are:
Each of the routines is described in its own section along with its top-level functionality. In most cases, the initial menu choice will lead to further requests for information until the routine has sufficient information to accomplish its task. To use any routine from the Terminal, the user must be in the %SYS namespace and have at least the %Manager role. The routine, for example ^SECURITY, is invoked as expected with the command:
When the routine runs, it presents you with a list of options. Select an option by entering its number after the “Option?” prompt.
As previously noted, the preferred way to manage an InterSystems IRIS system is via the Management Portal. Administrators who elect to use the routines described in this documents are assumed to have a detailed operating knowledge of how InterSystems IRIS works and what parameter values are appropriate for the options they choose.
General notes about prompts
The following are characteristics of prompts when using the character-based facilities:
There is nothing to prevent multiple instances of the same routine from being executed at the same time by different system administrators (or even the same administrator). If this happens, it is the responsibility of the administrators to coordinate their activity to avoid conflicts and achieve their objectives with regard to the coherence of the affected data.
This routine addresses the setup and maintenance of the data essential to the proper functioning of InterSystems security. The initial menu includes:
  1. User setup
    Users represent actual people or other entities who are permitted access to the system. This is the section for define the characteristics of users for the instance.
  2. Role setup
    InterSystems IRIS users are given permission to perform an action by their assignment to one or more roles. This section is where the characteristics of roles are defined.
  3. Service setup
    Services control the ability to connect to InterSystems IRIS using various connection technologies. They are predefined by InterSystems. The parameters governing their use are set through this option.
  4. Resource setup
    Resources represent assets, such as databases or applications, whose use is to be managed. A resource may represent a single asset such as a database, or it may protect multiple (usually related) assets such as a suite of applications.
  5. Application setup
    Application definitions serve as proxies for the actual application code. Permissions on the definition are interpreted by the security system as granting the same permission on the application associated with the definition.
    Because client applications are only available on Windows, the options associated client applications do not appear on other operating systems.
  6. Auditing setup
    Auditing is the means by which InterSystems IRIS keeps a record of security-related events. This section deals with the definition and management of events whose occurrence is to be noted in the audit log.
  7. Note:
    This option does not exist.
  8. SSL configuration setup
    SSL/TLS provides authentication and other functionality. This section provides configuration tools if the instance uses InterSystems IRIS support for the SSL/TLS protocol; this includes the use of SSL/TLS with mirroring, such as for creating and editing SSL/TLS configurations for use with mirroring.
  9. Mobile phone service provider setup
    With two-factor authentication, authenticating users receive a one-time security code on their mobile phone that they then enter at a prompt. This section provides the tools for configuring the mobile phone service providers in use for the InterSystems IRIS instance.
  10. OpenAM Identity Services setup
    OpenAM identity services allow InterSystems IRIS to support single-sign on (SSO). This section deals with managing OpenAM identity services for the InterSystems IRIS instance. If users have already successfully authenticated, OpenAM eliminates the need to re-authenticate. Using this option, you can use the %SYS.OpenAM.IdentityServices class API to authenticate against a specified OpenAM server.
    To use OpenAM via a web policy agent, you must install and configure the web policy agent on the web server that you are using with InterSystems IRIS.
    When a user connects, the web policy agent redirects that user to the OpenAM server. The OpenAM server authenticates and directs the user to the system to which they are connecting; it also provides them with an OpenAM token in a cookie. The web policy agent recognizes the token, validates it with the OpenAM server, sets the value of the REMOTE_USER variable to their username, and connects to the web server. The web application can then set $USERNAME to the value of REMOTE_USER, such as through delegated authentication. Subsequent connections to any supported service validate the token, so the original authentication is persistent.
    In order to do this, you must install and configure a Web Policy Agent on the server Web Server that you are using with InterSystems IRIS.
  11. Encryption key setup
    InterSystems IRIS uses keys to encrypt databases or user-specified data elements. This section provides tools for working with keys for both database and managed encryption.
  12. System parameter setup
    The system parameters are a collection of security-related values that apply system-wide. This section includes the ability to export and import all an instance’s security settings, including those for SQL privileges.
    Considerations related to importing settings:
    • If you are importing security settings from a source instance configured with multiple domains to a target instance not configured to allow multiple domains and the source instance’s default domain differs from that of the target instance, then the import does not update the target’s default domain — you must explicitly set this value. To do this, use the Default security domain drop-down on the System-wide Security Parameters page (System Administration > Security > System Security > System-wide Security Parameters).
    • When importing all security settings, the import/export file includes web application settings; each web application has a Path setting. Before importing settings onto a new drive, VM, or hardware, for each web application, ensure that the value of the Path setting is accurate for that environment. If the web applications associated with the Management Portal do not have correct Path values, the Management Portal will not display correctly.
      To locate the Path setting for each web application in the import/export file (SecurityExport.xml), look in the ApplicationsExport section; in each Applications section, identify the application by the value of the Name setting; then update the value of the Path setting as appropriate.
  13. X509 User setup
    X.509 is the standard for certificates that a public key infrastructure (PKI) uses. InterSystems IRIS uses X.509 certificates for its PKI, and each user associated with an X.509 certificate is known as an X.509 user. This section provides tools for working with X.509 users, such as creating them, editing them, deleting them, and so on.
  14. Exit
The ^EncryptionKey routine is for use with managed key encryption; it supports operations for encryption key management (technology for creation and management of encryption keys and key files), database encryption, and data-element encryption.
  1. Create new encryption key and key file
    Allows you to create a new database-encryption key, which it stores in a key file.
  2. Manage existing encryption key file
    Allows you to list administrators associated with a key file, add an administrator to a key file, remove an administrator from a key file, and convert a version 1.0 key file to a version 2.0 key file.
  3. Database encryption
    Allows you to activate a database encryption key, display the unique identifier for the currently activated database encryption key (if there is one), deactivate the activated database encryption key, and configure InterSystems IRIS startup options related to database encryption.
  4. Data element encryption for applications
    Allows you to activate a data-element encryption key, list the unique identifier for any currently activated data-element encryption keys (if there are any), and deactivate the activated data-element encryption key.
The ^DATABASE routine is used to manage databases; it also allows you to set values related to InterSystems security.
  1. Create a database
    Allows you to create a new database.
  2. Edit a database
    Allows you to change the characteristics of an existing database, for example, by adding additional volumes.
  3. List databases
    Displays the characteristics of one or more databases.
  4. Delete a database
    Allows you to delete an InterSystems IRIS database. This action is irreversible.
  5. Mount a database
    Makes a database ready for use by InterSystems IRIS. Databases must be mounted to InterSystems IRIS in order to be usable. Databases can be set to be automatically mounted at startup.
    You can use the Mount a database option to mount any IRIS.DAT file accessible to the instance by specifying the directory containing it. However, if you do this with a database that was deleted from, or was never added to, the Management Portal database configuration (see Configuring Databases in the “Configuring InterSystems IRIS” chapter of the System Administration Guide), the database is not added to the Management Portal configuration and is therefore unavailable for portal database operations and for some routines, for example ^Integrity (see Checking Database Integrity Using the ^Integrity Utility in the “Introduction to Data Integrity” chapter of the Data Integrity Guide).
  6. Dismount a database
    Permits you to quiesce a database and remove it from use by InterSystems IRIS.
  7. Compact globals in a database
    Reorganizes the data inside IRIS.DAT. Note that this option does not reduce the size of the database file; to reduce the size of the database, see option 13.
  8. Show free space for a database
    Displays the available space for a database. This is calculated as the difference between its current contents and its current declared size.
  9. Show details for a database
    Displays detailed information on a specified database including location, size, status, and other controlling parameters.
  10. Recreate a database
    Creates a new, empty database with the parameters of the original database. The new database is the same size as the original database.
  11. Manage database encryption
    Removes all the logical data from a database while preserving the properties of the database for reuse.
  12. Return unused space for a database
    Frees either a specified amount of or all available extra space associated with a database, reducing it from its current size to its smallest possible size.
  13. Compact freespace in a database
    Specifies the desired amount of freespace (unused space) that is in a database after the end of the database's data. You can also eliminate this freespace using the Return unused space for a database option (#12).
  14. Defragment globals in a database
    Defragments a database, which organizes its data more efficiently. Defragmentation may leave freespace in a database (see options #12 and #13).
This routine allows the reporting of data from the logs, and the manipulation of entries in the audit logs as well as the logs themselves.
  1. Audit reports
    Permits you to specify selection criteria (date ranges, events, affected users, and so on) and display characteristics, then extracts the data from the audit log and formats it for presentation.
  2. Manage audit logs
    Allows the extraction of log entries to another namespace, the export and import of audit log data to and from external files, and maintenance activities against the audit log itself.
  3. Exit

Previous section          
Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-08-16 05:39:10