Note on usage
Function: Modify key
User group: FT administrator
Alias name: FTMODKEY
Functional description
You can use the MODIFY-FT-KEY command to modify the expiration date and authentication level of keys that are used for the authentication of partner systems. The changes are stored in the relevant key file.
Once the expiration date of a key has been reached, authentication using this key is rejected. However, you can still modify the expiration date after the key’s validity date has expired, e.g. in order to temporarily re-enable a key so that a current key can be transferred securely.
Format
MODIFY-FT-KEY / FTMODKEY |
PARTNER-NAME = *ALL / <name 1..8> ,AUTHENTICATION-LEVEL = *UNCHA NGED / <integer 1..2> ,EXPIRATION-DATE = *UNCHA NGED / *NONE / <date 8..10> |
Operands
PARTNER-NAME =
Specifies the partner whose key is to be modified.
PARTNER-NAME = *ALL
The installed keys of all partner systems are modified.
PARTNER-NAME = <name 1..8>
Name of the partner whose key is modified.
AUTHENTICATION-LEVEL =
Specifies the authentication level for the key or keys.
AUTHENTICATION-LEVEL = *UNCHANGED
The authentication level remains unchanged.
AUTHENTICATION-LEVEL = 1
The authentication level for the partner or partners is set to 1. This corresponds to the options available up to openFT V11.0A.
If the partner system is subsequently authenticated at level 2, then the entry AUTHENTICATION-LEVEL=2 is automatically recorded in its key file.
AUTHENTICATION-LEVEL = 2
The partner system supports the level 2 authentication procedure introduced in openFT V11.0B . Level 1 authentication attempts are rejected.
EXPIRATION-DATE =
Specifies the expiration date of the key or keys.
EXPIRATION-DATE = *UNCHANGED
The expiration date remains unchanged.
EXPIRATION-DATE = *NONE
No expiration date for the key or keys.
EXPIRATION-DATE = <date 8..10>
Expiration date in the format yyyy-mm-dd or yy-mm-dd, e.g.. 2017-12-31 or 17-12-31 for December 31, 2017. The key or keys can be used for authentication at the latest up until the time 00:00 on the specified date.
Command return codes
(SC2) | SC1 | Maincode | Meaning |
0 | 0 | CMD0001 | The key has been modified. |
83 | 32 | CMD0221 | Internal error. |
35 | 64 | FTR1035 | Command only permissible for FT administrator. |
76 | 64 | FTR1076 | Selected key file not found. |
2 | 0 | FTR1087 | Key expired. |
SC1/2 = Subcode 1/2 in decimal notation For additional information, see section “Command return codes”. | |||