This section describes each of the Safeguard programs and their options. The following table indicates which Safeguard component installs each program.
Table 14: Privilege Manager programs
|
pmauditsrv |
Verifies that the configured audit servers are accessible and configured properly and exchanges a "hello" message with the server.
If the audit server is not accessible, stores the events and keystroke (IO) logs temporarily offline and sent to the audit server when it is available. |
X |
N/A |
N/A |
| pmcheck |
Verifies the syntax of a policy file. |
X |
N/A |
X |
| pmgit |
The pmgit utility is used to configure Git policy management for Privilege Manager for Unix. |
X |
X |
N/A |
| pmjoin_plugin |
Joins a Sudo Plugin to the specified policy server. Joining configures the remote host to communicate with the servers in the group. |
X |
N/A |
X |
| pmkey |
Generates and installs configurable certificates. |
X |
X |
X |
| pmlicense |
Displays current license information and allows you to update a license (an expired one or a temporary one before it expires) or create a new one. |
X |
N/A |
N/A |
| pmloadcheck |
Controls load balancing and failover for connections made from the host to the configured policy servers. |
X |
X |
N/A |
| pmlog |
Displays entries in a Privilege Manager for Unix event log. |
X |
N/A |
N/A |
| pmlogadm |
Manages encryption options on the event log. |
X |
N/A |
N/A |
| pmlogsearch |
Searches all logs in a policy group based on specified criteria. |
X |
N/A |
N/A |
|
pmlogsrvd |
The Privilege Manager for Unix log access daemon, the service responsible for committing events to the Privilege Manager for Unix event log and managing the database storage used by the event log. |
X |
|
|
| pmlogxfer |
Transfers event logs and I/O logs after an off-line policy evaluation has occurred. pmlogxfer is initiated by pmloadcheck when there are log files queued for transfer from a Sudo Plugin host to the server. |
N/A |
N/A |
X |
| pmmasterd |
The Privilege Manager for Unix Master daemon which examines each user request and either accepts or rejects it based upon information in the Privilege Manager configuration file. You can have multiple pmmasterd daemons on the network to avoid having a single point of failure. |
X |
N/A |
X |
| pmplugininfo |
Displays information about the policy server group that the Sudo Plugin host has joined. |
X |
N/A |
X |
| pmpluginloadcheck |
A daemon that runs on each Sudo Plugin host and controls load balancing and failover for connections made from the host to the configured policy servers. |
X |
N/A |
X |
| pmpolicy |
A command-line utility for managing the Privilege Manager for Unix security policy. This utility checks out the current version, checks in an updated version, and reports on the repository. |
X |
N/A |
N/A |
| pmpolicyplugin |
Displays the revision status of the cached security policy on a Sudo Plugin host; allows you to request an update from the central repository. |
N/A |
N/A |
X |
| pmpoljoin_plugin |
Adjunct program to the pmjoin_plugin script. pmpoljoin_plugin is called by the pmjoin_plugin script when configuring a Sudo Plugin host to setup up the required read-only access to the policy repository, so that the client can operate in off-line mode. |
N/A |
N/A |
X |
| pmpolsrvconfig |
Configures (or unconfigures) a primary or secondary policy server. Allows you to grant a user access to a repository. |
X |
N/A |
N/A |
| pmremlog |
Provides a wrapper for the pmlog and pmreplay utilities to access the event (audit) and keystroke (I/O) logs on any server in the policy group. |
X |
N/A |
N/A |
| pmreplay |
Replays an I/O log file allowing you to review what happened during a previous privileged session. |
X |
N/A |
N/A |
| pmresolvehost |
Verifies the host name or IP resolution for the local host or a selected host. |
X |
X |
X |
| pmserviced |
The Privilege Manager for Unix Service daemon listens on the configured ports for incoming connections for the Privilege Manager for Unix daemons. pmserviced uses options in pm.settings to determine the daemons to run, the ports to use, and the command line options to use for each daemon. |
X |
X |
X |
| pmsrvcheck |
Checks the Privilege Manager for Unix policy server configuration to ensure it is setup properly. |
X |
N/A |
N/A |
| pmsrvconfig |
Configures a primary or secondary policy server. |
X |
N/A |
N/A |
| pmsrvinfo |
Verifies the policy server configuration. |
X |
N/A |
N/A |
| pmsum |
Generates a simple checksum of a binary. |
X |
N/A |
N/A |
| pmsysid |
Displays the Privilege Manager for Unix system ID. |
X |
X |
X |
Syntax
$ pmauditsrv -h
Usage: pmauditsrv [-h] [-v] [-z on|off]
Usage: pmauditsrv check|send [ -o <serverlist> ] [ -b <ca_bundle_file> ] [ -k <privatekey_file> ] [ -c <certificate_file> ] [ -s ]
Description
Use pmauditsrv for the following:
- pmauditsrv verifies that the configured audit servers are accessible and configured properly. This includes verifying that certificates and keys are configured properly for TLS communication, if enabled. pmauditsrv exchanges a "hello" message with the server.
- When the policy server is configured for "not enforced mode" and the audit server is not accessible, pmauditsrv can be used to store the event logs and keystroke (IO) logs temporarily offline. pmauditsrv sends the logs to the audit server once it is available. If the connection to the audit server was broken in the middle of the command run and the log is a partial log, the log will be sent to the same server that received the first part of the message. Logs which are not partial logs are sent to the audit servers according to the actual configuration. Changing the auditserver configurations can solve transferring full but not partial logs.
By default, the pmloadcheck program executes pmauditsrv in every 30 minutes to transfer any audit trail files found in the configured cache directory to the audit server. If the file can not be processed (for example, the file is corrupt), pmauditsrv moves the file into a subdirectory (quarantine).
pmauditsrv can be called manually for troubleshooting an issue.
With command ’check’ .B, pmauditsrv can be also used to check connection to the configured audit servers or the server specified with command line arguments.
Errors logs are stored in /var/log/pmmasterd.log.
Options
pmauditsrv has the following options.
Table 15: Options: pmauditsrv
|
-h |
Display a help usage information and exit. |
|
-v |
Display the version number of the pmauditsrv program and exit. |
|
-z on | off |
Turn debug tracing on or off, then exit. |
|
-o <serverlist> |
Specify audit servers.
Format: addr1:port1..addrn:portn where addr is either IP or hostname. |
|
-b <ca_bundle_ file> |
Specify CA bundle file for TLS connection. |
|
-k <privatekey_ file> |
Specify private key file for TLS connection |
|
-c <certificate_ file> |
Specify certificate file for TLS connection |
|
-s |
Redirects all error messages to the syslog. |
Related Topics
pmloadcheck
pmmasterd
pmsrvconfig
Syntax
pmcheck [ -z on|off[:<pid>] ] | [ -v ] |
[ [ -a <string> ] [ -b ] [ -c ] [ -e <requestuser> ]
[ -f <filename> ] [ -g <group> ] [ -h <hostname> ] [ -i ]
[ -m <YY[YY]/MM/DD> ] [ -n <HH[:MM]> ]
[ -o sudo|pmpolicy ] [ -p <policydir> ] [ -q ] [ -r <remotehost> ]
[ -s <submithost> ] [ -t ] [ -u <runuser> ] [ command [ args ]]]
Description
Use the pmcheck command to test the policy file. Although the policy server daemon pmmasterd reports configuration file errors to a log file, always use pmcheck to verify the syntax of a policy file before you install it on a live system. You can also use the pmcheck command to simulate running a command to test whether a request will be accepted or rejected.
The pmcheck program exits with a value corresponding to the number of syntax errors found.
Options
pmcheck has the following options.
Table 16: Options: pmcheck
|
-a <string> |
Checks if the specified string, entered during the session, matches any alertkeysequence configured. You can only specify this option if you supply a command.
This option is only relevant when using the pmpolicy type. |
|
-b |
Run in batch mode. By default, pmcheck runs in interactive mode, and attempts to emulate the behavior of the pmmasterd when parsing the policy file. The -b option ensures that no user interaction is required if the policy file contains a password or input function; instead, a successful return code is assumed for any password authentication functions. |
|
-c |
Runs in batch mode and displays output in csv format. By default pmcheck runs in interactive mode. The -c option ensures that no user interaction is required if the policy file contains a password prompt or input function and no commands that require remote connections are attempted. |
|
-e <requestuser> |
Sets the value of requestuser. This option allows you to specify the group name to use when testing the configuration. This emulates running a session using the sudo -u <user> option to request that Safeguard runs the command as a particular runuser. |
|
-f <filename> |
Sets path to policy filename. Provides an alternative configuration filename to check. If not fully qualified, this path is interpreted as relative to the policydir, rather than to the current directory. |
|
-g <group> |
Sets the group name to use. If not specified, then pmcheck looks up the user on the master policy server host to get the group information. This option is useful for checking a user and group that does not exist on the policy server. |
|
-h <hostname> |
Specifies execution host used for testing purposes. |
|
-i |
Ignores check for root ownership of policy. |
|
-m <YY[YY]/MM/DD> |
Checks the policy for a particular date. Enter Date in this format: YY[YY]/MM/DD. Defaults to the current date. |
|
-n <HH[:MM]> |
Checks the policy for a particular time. Enter Time in this format: HH[:mm]. Defaults to the current time. |
|
-o <policytype> |
Interprets the policy with the specified policy type:
|
| -p policydir |
Forces pmcheck to use a different directory to search for policy files included with a relative pathname. The default location to search for policy files is the policydir setting in pm.settings. |
| -q |
Runs in quiet mode, pmcheck does not prompt the user for input, print any errors or prompts, or run any system commands. The exit status of pmcheck indicates the number of syntax errors found (0 = success). This is useful when running scripted applications that require a simple syntax check. |
| -r remotehost |
Sets the value of the clienthost variable within the configuration file, useful for testing purposes.
The clienthost variable is set to the value of the submithost variable. |
| -s submithost |
Sets the value of the submithost variable within the configuration file, useful for testing purposes. |
| -t |
Runs in quiet mode to check whether a command would be accepted or rejected. By default, pmcheck runs in interactive mode. The -t option ensures that no user interaction is required if the policy file contains a password prompt or input function, no output is displayed and no commands that require remote connections are attempted.
Exit Status:
- 0: Command accepted
- 11: Password prompt encountered. The command will only be accepted if authentication is successful
- 12: Command rejected
- 13: Syntax error encountered
|
| -u <runuser> |
Sets the value of the runuser variable within the configuration file, useful for testing purposes. |
| -v |
Displays the version number of Safeguard and exits. |
| -z |
Enables or disables debug tracing, and optionally sends SIGHUP to running process.
Refer to Enabling Program-level Tracing before using this option. |
|
command [args] |
Sets the command name and optional arguments. |
You can use pmcheck two ways: to check the syntax of the configuration file, or to test whether a request is accepted or rejected (that is, to simulate running a command).
By default, pmcheck runs the configuration file interactively in the same way as pmmasterd and reports any syntax errors found. If you supply an argument to a command, it reports whether the requested command is accepted or rejected. You can use the -c and -q options to verify the syntax in batch or silent mode, without any user interaction required.
When you run a configuration file using pmcheck, you are allowed to modify the values of the incoming variables. This is useful for testing the configuration file's response to various conditions. When pmmasterd runs a configuration file, the incoming variables are read-only.
Example
To verify whether the sudoer policy file /etc/sudoers, ingoring permissions and ownership, allows user jsmith in the users group to run the passwd root command on host, host1, enter:
pmcheck -f /etc/sudoers -i -o sudo -u jsmith -g users
-h host1 passwd root
Syntax
pmgit <subcommand> [arguments]
Description
The pmgit utility is a tool that can mediate version control operations between Subversion (SVN) and Git version control systems.
For more information on the pmgit policy management concept, see Managing policies in Git.
The pmgit utility has several subcommands, each with its own set of options and arguments. For each subcommand, pmgit returns 0 if the operation succeeds or 1 if an error occurred.
For more information on the subcommands, see:
