|
Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
|
Security configuration interface More...
import <Security.idl;
Public Member Functions | |
| boolean | getHttpRedirSettings () |
| Retrieve the current state of the HTTP-to-HTTPS redirection. | |
| void | setHttpRedirSettings (in boolean http2httpsRedir) |
| Enable or disable HTTP-to-HTTPS redirection. | |
| boolean | isHstsEnabled () |
| Check whether HTTP Strict Transport Security (HSTS) is enabled. | |
| void | setHstsEnabled (in boolean enable) |
| Enable or disable HTTP Strict Transport Security (HSTS). | |
| IpFw | getIpFwSettings () |
| Retrieve the IPv4 packet filter configuration. | |
| int | setIpFwSettings (in IpFw ipFw) |
| Set the IPv4 packet filter configuration. | |
| IpFw | getIpV6FwSettings () |
| Retrieve the IPv6 packet filter configuration. | |
| int | setIpV6FwSettings (in IpFw ipV6Fw) |
| Set the IPv6 packet filter configuration. | |
| RoleAccessControl | getRoleAccessControlSettings () |
| Retrieve the role-base access control settings for IPv4. | |
| int | setRoleAccessControlSettings (in RoleAccessControl settings) |
| Change the role-based access control settings. | |
| RoleAccessControl | getRoleAccessControlSettingsV6 () |
| Retrieve the role-base access control settings for IPv6. | |
| int | setRoleAccessControlSettingsV6 (in RoleAccessControl settings) |
| Change the role-based access control settings for IPv6. | |
| BlockSettings | getBlockSettings () |
| Retrieve the current user blocking settings. | |
| int | setBlockSettings (in BlockSettings settings) |
| Change the user blocking settings. | |
| PasswordSettings | getPwSettings () |
| Retrieve the password settings. | |
| int | setPwSettings (in PasswordSettings pwSettings) |
| Change the password settings. | |
| int | getIdleTimeoutSettings () |
| Retrieve the current idle timeout. | |
| int | setIdleTimeoutSettings (in int idleTimeout) |
| Change the session idle timeout. | |
| boolean | getSingleLoginLimitation () |
| Retrieve the current single-login limitation setting. | |
| void | setSingleLoginLimitation (in boolean singleLogin) |
| Enable or disable single login limitation. | |
| SSHSettings | getSSHSettings () |
| Retrieve the current SSH settings. | |
| void | setSSHSettings (in SSHSettings settings) |
| Change the SSH settings. | |
| vector< SSHHostKey > | getSSHHostKeys () |
| Retrieve the host SSH keys. | |
| RestrictedServiceAgreement | getRestrictedServiceAgreement () |
| Retrieve the current Restricted Service Agreement settings. | |
| int | setRestrictedServiceAgreement (in RestrictedServiceAgreement settings) |
| Change the Restricted Service Agreement settings. | |
| vector< string > | getSupportedFrontPanelPrivileges () |
| Retrieve a list of supported privileges for the front panel. | |
| vector< string > | getFrontPanelPrivileges () |
| Retrieve the list of active front panel privileges. | |
| int | setFrontPanelPrivileges (in vector< string > privileges) |
| Set the privileges for the front panel. | |
| int | setDefaultAdminAccountPassword (in string password, in boolean disableStrongPasswordReq) |
| Set the default admin account password and optionally disable strong password requirements. | |
| int | setAdminAccountPasswordHash (in string passwordHash) |
| Set the password hash for the admin user. | |
| boolean | isSecureBootActive () |
| Check whether secure boot is active. | |
| TpmInfo | getTpmInfo () |
| Return information about an installed Secure Element. | |
| FipsSettings | getActiveFipsSettings () |
| Get active FIPS settings. | |
| FipsSettings | getPersistentFipsSettings () |
| Get persistent FIPS settings. | |
| void | setPersistentFipsSettings (in FipsSettings settings) |
| Set persistent FIPS settings. | |
Public Attributes | |
| constant int | ERR_INVALID_VALUE = 1 |
| Invalid arguments. | |
Security configuration interface
Definition at line 150 of file Security.idl.
| FipsSettings security::Security::getActiveFipsSettings | ( | ) |
Get active FIPS settings.
| BlockSettings security::Security::getBlockSettings | ( | ) |
Retrieve the current user blocking settings.
| vector< string > security::Security::getFrontPanelPrivileges | ( | ) |
Retrieve the list of active front panel privileges.
| boolean security::Security::getHttpRedirSettings | ( | ) |
Retrieve the current state of the HTTP-to-HTTPS redirection.
true if the HTTP-to-HTTPS redirection is enabled | int security::Security::getIdleTimeoutSettings | ( | ) |
Retrieve the current idle timeout.
| IpFw security::Security::getIpFwSettings | ( | ) |
Retrieve the IPv4 packet filter configuration.
| IpFw security::Security::getIpV6FwSettings | ( | ) |
Retrieve the IPv6 packet filter configuration.
| FipsSettings security::Security::getPersistentFipsSettings | ( | ) |
Get persistent FIPS settings.
Those settings are applied on next boot and may differ from currently active settings.
| PasswordSettings security::Security::getPwSettings | ( | ) |
Retrieve the password settings.
| RestrictedServiceAgreement security::Security::getRestrictedServiceAgreement | ( | ) |
Retrieve the current Restricted Service Agreement settings.
| RoleAccessControl security::Security::getRoleAccessControlSettings | ( | ) |
Retrieve the role-base access control settings for IPv4.
| RoleAccessControl security::Security::getRoleAccessControlSettingsV6 | ( | ) |
Retrieve the role-base access control settings for IPv6.
| boolean security::Security::getSingleLoginLimitation | ( | ) |
Retrieve the current single-login limitation setting.
true if single-login limitation is enabled | vector< SSHHostKey > security::Security::getSSHHostKeys | ( | ) |
Retrieve the host SSH keys.
| SSHSettings security::Security::getSSHSettings | ( | ) |
Retrieve the current SSH settings.
| vector< string > security::Security::getSupportedFrontPanelPrivileges | ( | ) |
Retrieve a list of supported privileges for the front panel.
| TpmInfo security::Security::getTpmInfo | ( | ) |
Return information about an installed Secure Element.
The name getTpmInfo is kept for backward compatibility.
| boolean security::Security::isHstsEnabled | ( | ) |
Check whether HTTP Strict Transport Security (HSTS) is enabled.
true when HSTS is enabled | boolean security::Security::isSecureBootActive | ( | ) |
Check whether secure boot is active.
ATTENTION: There are some uncertainties involved here. It is possible that it reports secure boot active while it isn't. Theoretically also the opposite is possible. For that reason the result of this function may not be used to reduce any security checks!
true if secure boot is active | int security::Security::setAdminAccountPasswordHash | ( | in string | passwordHash | ) |
Set the password hash for the admin user.
Naturally, this circumvents checks for password complexity requirements and the password history, since we only receive the salted hash of a password.
This method is only allowed on link units when called by the primary unit.
| int security::Security::setBlockSettings | ( | in BlockSettings | settings | ) |
Change the user blocking settings.
| settings | New settings |
| int security::Security::setDefaultAdminAccountPassword | ( | in string | password, |
| in boolean | disableStrongPasswordReq ) |
Set the default admin account password and optionally disable strong password requirements.
The purpose of this method is to set the default admin account password when the device is unprovisioned, i.e. has not been configured yet or has been reset to factory defaults. The difference to the regular setAccountPassword() method in the User::idl is that this method allows to disable the strong password requirements at the same time. It allows choosing a weaker password in case strong password requirements are not needed for the specific purpose.
| password | The new password |
| disableStrongPasswordReq | true to disable strong password requirements false to keep the current strong password requirement setting |
| int security::Security::setFrontPanelPrivileges | ( | in vector< string > | privileges | ) |
Set the privileges for the front panel.
| void security::Security::setHstsEnabled | ( | in boolean | enable | ) |
Enable or disable HTTP Strict Transport Security (HSTS).
| enable | true to enable HSTS |
| void security::Security::setHttpRedirSettings | ( | in boolean | http2httpsRedir | ) |
Enable or disable HTTP-to-HTTPS redirection.
| http2httpsRedir | true to enable the redirection |
| int security::Security::setIdleTimeoutSettings | ( | in int | idleTimeout | ) |
Change the session idle timeout.
| idleTimeout | New idle timeout in minutes |
| int security::Security::setIpFwSettings | ( | in IpFw | ipFw | ) |
Set the IPv4 packet filter configuration.
| ipFw | New packet filter settings |
| int security::Security::setIpV6FwSettings | ( | in IpFw | ipV6Fw | ) |
Set the IPv6 packet filter configuration.
| ipV6Fw | New packet filter settings |
| void security::Security::setPersistentFipsSettings | ( | in FipsSettings | settings | ) |
Set persistent FIPS settings.
Those settings are applied on next boot and may differ from currently active settings.
| settings | new persistent FIPS settings |
| int security::Security::setPwSettings | ( | in PasswordSettings | pwSettings | ) |
Change the password settings.
| pwSettings | New settings |
| int security::Security::setRestrictedServiceAgreement | ( | in RestrictedServiceAgreement | settings | ) |
Change the Restricted Service Agreement settings.
| settings | New settings |
| int security::Security::setRoleAccessControlSettings | ( | in RoleAccessControl | settings | ) |
Change the role-based access control settings.
| settings | New settings |
| int security::Security::setRoleAccessControlSettingsV6 | ( | in RoleAccessControl | settings | ) |
Change the role-based access control settings for IPv6.
| settings | New settings |
| void security::Security::setSingleLoginLimitation | ( | in boolean | singleLogin | ) |
Enable or disable single login limitation.
| singleLogin | true to enable single login limitation |
| void security::Security::setSSHSettings | ( | in SSHSettings | settings | ) |
Change the SSH settings.
| settings | New settings |
| constant int security::Security::ERR_INVALID_VALUE = 1 |
Invalid arguments.
Definition at line 152 of file Security.idl.
1.10.0