mirror of
https://github.com/hanzoai/kms.git
synced 2026-11-03 01:10:24 +00:00
189 lines
9.4 KiB
Plaintext
189 lines
9.4 KiB
Plaintext
---
|
|
title: "Unix/Linux Local Account Rotation"
|
|
description: "Learn how to automatically rotate Unix/Linux local account passwords."
|
|
---
|
|
|
|
<Note>
|
|
**Rotation Type: [Single-Phase](/documentation/platform/secret-rotation/overview#single-phase-rotation)**
|
|
|
|
This rotation updates a single credential set in place. Old credentials become invalid immediately upon rotation. This means that clients using the previous credentials will fail to authenticate until they retrieve the new credentials.
|
|
|
|
This is a limitation of the SSH provider and cannot be rectified by KMS.
|
|
</Note>
|
|
|
|
## Prerequisites
|
|
|
|
- Create an [SSH Connection](/integrations/app-connections/ssh) with the **Secret Rotation** requirements
|
|
- Ensure your network security policies allow incoming requests from KMS to this rotation provider, if network restrictions apply.
|
|
|
|
## Create a Unix/Linux Local Account Rotation in KMS
|
|
|
|
<Tabs>
|
|
<Tab title="KMS UI">
|
|
1. Navigate to your Secret Manager Project's Dashboard and select **Add Secret Rotation** from the actions dropdown.
|
|
|
|
|
|
2. Select the **Unix/Linux Local Account** option.
|
|
|
|
|
|
3. Select the **SSH Connection** to use and configure the rotation behavior. Then click **Next**.
|
|
|
|
|
|
- **SSH Connection** - the connection that will perform the rotation of the configured user's password.
|
|
- **Rotation Interval** - the interval, in days, that once elapsed will trigger a rotation.
|
|
- **Rotate At** - the local time of day when rotation should occur once the interval has elapsed.
|
|
- **Auto-Rotation Enabled** - whether secrets should automatically be rotated once the rotation interval has elapsed. Disable this option to manually rotate secrets or pause secret rotation.
|
|
<Note>
|
|
Due to Unix/Linux Local Account Rotations rotating a single credential set, auto-rotation may result in service interruptions. If you need to ensure service continuity, we recommend disabling this option.
|
|
</Note>
|
|
|
|
|
|
4. Configure the required Parameters for your rotation. Then click **Next**.
|
|
|
|
|
|
- **Rotation Method** - The method to use when rotating the target user's password.
|
|
- **Login as Target** - KMS will use the provided SSH username and password to log in and rotate its own password.
|
|
- **Login as Root** - KMS will use the SSH Connection's credentials to log in and rotate the provided user's password.
|
|
- **Username** - The target SSH username whose password will be rotated.
|
|
- **Use Sudo** - If true, uses sudo when executing the password rotation command. Defaults to false.
|
|
- **Current Password** - The current password of the target user (required when **Rotation Method** is set to **Login as Target**).
|
|
- **Password Requirements** - The constraints to apply when generating new passwords.
|
|
|
|
5. Specify the secret names that the Unix/Linux credentials should be mapped to. Then click **Next**.
|
|
|
|
|
|
- **Username** - the name of the secret that the Unix/Linux username will be stored in.
|
|
- **Password** - the name of the secret that the rotated password will be stored in.
|
|
|
|
6. Give your rotation a name and description (optional). Then click **Next**.
|
|
|
|
|
|
- **Name** - the name of the secret rotation configuration. Must be slug-friendly.
|
|
- **Description** (optional) - a description of this rotation configuration.
|
|
|
|
7. Review your configuration, then click **Create Secret Rotation**.
|
|
|
|
|
|
8. Your **Unix/Linux Local Account** credentials are now available for use via the mapped secrets.
|
|
|
|
|
|
### Reconcile Unix/Linux Local Account
|
|
|
|
If you suspect the credentials are out of sync (for example, after a manual password change on the server), you can regain access by using **Reconcile**. This will use the configured SSH App Connection's root account to reset the target user's password and sync it with KMS.
|
|
|
|
|
|
|
|
</Tab>
|
|
<Tab title="API">
|
|
To create a Unix/Linux Local Account Rotation, make an API request to the [Create Unix/Linux
|
|
Local Account Rotation](/api-reference/endpoints/secret-rotations/unix-linux-local-account/create) API endpoint.
|
|
|
|
### Sample request
|
|
|
|
```bash Request
|
|
curl --request POST \
|
|
--url https://us.kms.hanzo.ai/api/v2/secret-rotations/unix-linux-local-account \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"name": "my-unix-linux-rotation",
|
|
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"description": "my unix/linux local account rotation",
|
|
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"environment": "dev",
|
|
"secretPath": "/",
|
|
"isAutoRotationEnabled": false,
|
|
"rotationInterval": 30,
|
|
"rotateAtUtc": {
|
|
"hours": 0,
|
|
"minutes": 0
|
|
},
|
|
"parameters": {
|
|
"rotationMethod": "login-as-root",
|
|
"username": "appuser",
|
|
"passwordRequirements": {
|
|
"length": 48,
|
|
"required": {
|
|
"digits": 2,
|
|
"lowercase": 2,
|
|
"uppercase": 2,
|
|
"symbols": 2
|
|
},
|
|
"allowedSymbols": "-_.~!*"
|
|
}
|
|
},
|
|
"secretsMapping": {
|
|
"username": "UNIX_USERNAME",
|
|
"password": "UNIX_PASSWORD"
|
|
}
|
|
}'
|
|
```
|
|
|
|
<Note>
|
|
Due to Unix/Linux Local Account Rotations rotating a single credential set, auto-rotation may result in service interruptions. If you need to ensure service continuity, we recommend disabling this option.
|
|
</Note>
|
|
|
|
### Sample response
|
|
|
|
```bash Response
|
|
{
|
|
"secretRotation": {
|
|
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"name": "my-unix-linux-rotation",
|
|
"description": "my unix/linux local account rotation",
|
|
"secretsMapping": {
|
|
"username": "UNIX_USERNAME",
|
|
"password": "UNIX_PASSWORD"
|
|
},
|
|
"isAutoRotationEnabled": false,
|
|
"activeIndex": 0,
|
|
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"createdAt": "2023-11-07T05:31:56Z",
|
|
"updatedAt": "2023-11-07T05:31:56Z",
|
|
"rotationInterval": 30,
|
|
"rotationStatus": "success",
|
|
"lastRotationAttemptedAt": "2023-11-07T05:31:56Z",
|
|
"lastRotatedAt": "2023-11-07T05:31:56Z",
|
|
"lastRotationJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"nextRotationAt": "2023-11-07T05:31:56Z",
|
|
"connection": {
|
|
"app": "ssh",
|
|
"name": "my-ssh-connection",
|
|
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
|
},
|
|
"environment": {
|
|
"slug": "dev",
|
|
"name": "Development",
|
|
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
|
|
},
|
|
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"folder": {
|
|
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"path": "/"
|
|
},
|
|
"rotateAtUtc": {
|
|
"hours": 0,
|
|
"minutes": 0
|
|
},
|
|
"lastRotationMessage": null,
|
|
"type": "unix-linux-local-account",
|
|
"parameters": {
|
|
"rotationMethod": "login-as-root",
|
|
"username": "appuser",
|
|
"passwordRequirements": {
|
|
"length": 48,
|
|
"required": {
|
|
"digits": 2,
|
|
"lowercase": 2,
|
|
"uppercase": 2,
|
|
"symbols": 2
|
|
},
|
|
"allowedSymbols": "-_.~!*"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|