ROBOT Checkout
Robot entities (scripts, programs, that is, non-human identities) can take the data they need to connect to a system out of PassMan with increased security (mTLS authentication). The script or program takes the passwords it needs out of PassMan with a certificate-based mTLS sign-in.
Conditions of mTLS authentication
- On the client (ROBOT) side, you need:
- the public certificate of the client, for example
client_1.crt; - the private key of the client, for example
client_2.key.
- the public certificate of the client, for example
- On the server side, you need the public certificate of the CA that signed the client certificate (
Root_CA.crt). This can be a root CA certificate, intermediate CA certificates, or a chain: root and intermediate together. - The name of the robot user added in PassMan and the user name in the certificate must be the same.
- The robot user added in PassMan must be active (not suspended).
- The mTLS sign-in mode must be enabled in Padmin (enabling mTLS checkout; details under Security settings > ROBOT (Non Human Identity) settings).
Preconditions for viewing a password with mTLS
- The mTLS authentication succeeds.
- The UID in the call exists (it is not deleted).
- The robot name (robot user name) in the call exists and is active (not suspended).
- The robot user has at least the password view permission on the referenced UID.
Format requirements of the client certificate
The OtherName parameter of the client certificate must contain the certificate descriptor set in Padmin and the user name of the robot (for example, robot1).
Example data in the certificate: OtherName=1.3.6.1.4.1.99999.1;UTF8:appID=robot1
- 99999 - company identifier. On the open internet, this must be the registered identifier of the company (registration: IANA); on an internal network, it can be any value.
- appID - required. The mTLS sign-in happens only if this string is given.
- robot1 - the name of the robot user. It can be anything, but there must be a robot user with the same name for the sign-in to succeed.
Uploading the server certificate
Upload Root_CA.crt: in PassMan, upload the certificate or certificates to the Robot_target target in the ROBOT folder, with the file upload function.
Preparations and settings
- Setting up PassMan for mTLS.
- Enabling and setting up the mTLS sign-in in Padmin.
- Uploading the Root_CA certificate.
- Creating robot users with the same names as the app_id values.
If a user's name is the same as the app_id in the certificate, but it is NOT a robot user, the mTLS password checkout does NOT work.
- Giving access permission to the items whose password or other connection data the user with that app_id wants to view.
Creating the certificates
With the Root_CA certificate, create the client certificates (one unique certificate for each client).
Collecting the data needed for the API call
- The client certificates.
app_id- the name of the robot user.account_id- the identifier of the account.credential_type- the type of credential you want to take out; usuallypassword.
The API call
Location and name of the call: api/robots/checkout, POST. Its parameters:
app_id- required string, the user name given in the certificate.account_id- required string, the account to check out.credential_type- required string, the type of credential to take out of the account. Its value set is not given in the Hungarian text.exclusive_duration- optional integer, for how many minutes to check it out.
Example REST response (status code 200):
{
"Content" : <password/ssh key/...>,
"UserName" : <username>,
"Target" : <address>, # the target name everywhere, but the full URL for web
"Autoreset" : <TRUE/FALSE>
}