Note on usage
Function: Show properties of RSA keys
User group: FT administrator
Functional description
You can use the ftshwk command to output the properties of RSA keys. You can display the RSA keys of your own instance as well as the RSA keys of partners.
Format
ftshwk -h
[ -own ]
[ -id=<identification 1..64> | -id=@a ]
[ -pn=<partner 1..200> | -pn=@a ] |
[ -exp=n | -exp=e | -exp=yyyymmdd | -exp=1..999 ]
[ -csv ]
Description
-h
Outputs the command syntax on screen. Any specifications after -h are ignored.
-own
Displays the key for your own instance.
-own must not be specified in combination with -pn or -id.
-id=identification | -id=@a
identification is the instance identification of the partner whose key is to be displayed. -id must not be specified in combination with -pn and -own.
@a
Displays the installed keys of all partner systems.
-pn=partner | -pn=@a
partner is the name of the partner system in the partner list or the address of the partner system whose key is to be displayed.
-pn must not be specified in combination with -id and -own.
You will find detailed information on address specifications in the section “Specifying partner addresses”.
@a
Displays the installed keys of all partner systems.
Neither -id nor -pn nor -own specified
Displays the keys of your own instance and the installed keys of all the partner systems.
-exp=n | -exp=e | -exp=yyyymmdd | -exp=1..999
Selects the keys on the basis of their expiration date.
n (no)
Displays all partner keys that do not have an expiration date.
e (expired)
Displays all partner keys that have already expired.
yyyymmdd
Displays all partner keys that expire at the latest at 00:00 local time on the specified date. For example, 20171201 displays all the keys that will become invalid by 00:00 on 01.12.2017.
1..999
Displays all partner keys that will expire within the specified number of days.
-exp not specified
The expiration date is not a selection criterion.
-csv
-csv specifies that the key properties are to be output in CSV format. The values in the output are separated by semicolons.
-csv not specified
The key properties are output in the default format.
Example
You want to output the properties of all the keys:
ftshwk CRE-DATE EXP-DATE KEY-LEN KEY-REF AUTHL PARTNER IDENTIFICATION 2021-07-20 768 5 2 2021-07-20 1024 5 2
2021-07-20 2048 5 2 2021-07-20 3072 5 2 2021-07-20 4096 5 2 2015-01-31 1024 6 2 2015-02-29 2048 7 2 2015-03-28 2017-12-24 2048 7 2 MYOWN MYOWNID.DOMAIN.NET 2015-07-12 EXPIRED 768 12 2 PC17QD PC17QD.DOMAIN.NET 2017-01-14 2048 1036 1 PC27ABC PC27ABC.DOMAIN.NET
Explanation:
CRE-DATE
Date on which the key was generated.
EXP-DATE
Date on which the key expires, i.e. 00:00 on the specified day. EXPIRED means that the key has already expired.
If there is no specification here then there is no expiration date.
KEY-LEN
Key length in bit: 768, 1024, 2048, 3072 or 4096
KEY-REF
Key reference
AUTHL
Authentication level: 1 or 2
PARTNER
Partner's name. This field is left empty for keys belonging to your own instance.
IDENTIFICATION
Partner's instance ID. This field is left empty for keys belonging to your own instance.