Locker Support

Locker Secrets có một giao diện dòng lệnh (CLI) mà bao gồm các chức năng phổ biến và định dạng đầu ra. CLI của Locker Secrets là một tệp nhị phân tĩnh duy nhất. Nó là một lớp bọc xung quanh API HTTP.

Cài đặt

Locker Secrets CLI có thể được tải xuống bằng các liên kết dưới đây:

Windows: https://locker.io/secrets/download/cli-windows

Linux: https://locker.io/secrets/download/cli-linux

MacOS (x64): https://locker.io/secrets/download/cli-mac-x64

MacOS (ARM): https://locker.io/secrets/download/cli-mac-arm64

Lược đồ dữ liệu của Locker Secrets

Có hai loại dữ liệu được mã hóa: secret (bí mật) và environment (môi trường), với mỗi secret thuộc về một môi trường cụ thể (mặc định là môi trường đặc biệt All). Dữ liệu tuân theo hai quy tắc sau để bắt buộc tính duy nhất:

Mỗi tên môi trường phải là duy nhất.

Mỗi (khóa secret, tên môi trường) phải là duy nhất.

Cấu trúc lệnh CLI

Mỗi lệnh được biểu diễn dưới dạng một lệnh hoặc lệnh con, và có một số tùy chọn lệnh và lệnh con có sẵn: các tùy chọn HTTP, các tùy chọn đầu ra và các tùy chọn cụ thể của lệnh.

Xây dựng lệnh CLI của Locker Secrets của bạn sao cho các tùy chọn lệnh đặt trước đường dẫn và các đối số nếu có:

locker <command> <subcommands> [flags]

Thứ tự ưu tiên của thông tin đăng nhập

Thông thường, một lệnh hoặc lệnh con của Locker Secrets phải được cung cấp với ID khóa truy cập và secret thông qua hai cờ:

locker secret list --access-key-id {id} --access-key-secret {secret}

Tuy nhiên, nếu biến môi trường LOCKER_ACCESS_KEY_IDvà LOCKER_ACCESS_KEY_SECRET được thiết lập hoặc dữ liệu thông tin đăng nhập được khởi tạo bằng cách thủ công hoặc bằng configuration, Locker Secret sẽ sử dụng chúng thay vì điều đó.

locker secret list // no access key flags required

Nếu có nhiều hơn một thông tin đăng nhập được cung cấp, Locker Secret sẽ ưu tiên theo thứ tự sau: cờ dòng lệnh → tệp thông tin đăng nhập → biến môi trường.

Global flags

--version: lấy thông tin phiên bản của Locker Secrets CLI.

--help: nhận trợ giúp của CLI về lệnh/lệnh con hiện tại.

--output: đặt cờ này để xuất kết quả đầu ra thành tệp output.txt trong thư mục làm việc hiện tại.

Lệnh `configuration`

Thiết lập các chi tiết của khóa truy cập vào tệp thông tin đăng nhập.

locker configuration --access-key-id {id} --secret-access-key {secret key}

Sẽ có một thông báo nhập cho bất kỳ cờ nào không được cung cấp.

Nếu có một ID khóa truy cập cũ và secret trong tệp thông tin đăng nhập, sẽ có một thông báo xác nhận để ghi đè lên chúng.

Lệnh `secret`

Thực hiện các hành động Đọc và Ghi trên các secret được mã hóa.

locker secret <subcommands> [flags]

Lệnh `environment`

Thực hiện các hành động Đọc và Ghi trên các môi trường được mã hóa.

locker environment <subcommands> [flags]

Cờ lệnh sử dụng chung cho lệnh `secret` , `environment` và `scan`

--output [string]: xuất dữ liệu đầu ra sang một tệp được chỉ định bởi đường dẫn.

--output-format: chỉ định định dạng đầu ra (json, env, txt) (txt mặc định), áp dụng cho dữ liệu đầu ra của cả terminal và tệp.

Cờ sử dụng chung cho lệnh `secret` và `environment`

--access-key-id [string]: lấy từ máy khách Locker Secrets.

--secret-access-key [string]: lấy từ máy khách Locker Secrets.

--headers [strings]: header tùy chỉnh cho các lệnh gọi API của Locker Secrets, phải ở dạng: “key1: value1, key2: value2”

--credential [string]: đường dẫn tới tệp thông tin, mặc định là $USER/.locker/credential.json

--api-base [string]: thiết lập API endpoint của máy chủ, mặc định là https://api.locker.io/locker_secrets

--agent [string]: chỉ định agent, mặc định là Locker Secret CLI - version xxx. Phải ở dạng agent - version, hiện chấp nhận Python, .Net, NodeJS, Java.

--fetch: đặt cờ này để buộc Locker Secrets lấy dữ liệu được mã hóa từ máy chủ đám mây thay vì bộ nhớ cục bộ.

--json: đặt cờ này để định dạng dữ liệu đầu ra thành JSON, nếu --output được đặt, tệp dữ liệu đầu ra sẽ được đổi tên thành output.json.

--dotenv: sử dụng với --output, đặt cờ này để đổi tên tệp đầu ra thành .env.

--resttime [int]: cài đặt thời gian ngừng hoạt động mong muốn giữa các lệnh gọi API tới máy chủ Locker Secrets.

Lệnh con `list`

Có sẵn trên các lệnh secret và environment.

Cờ tùy chọn:

--environment (cho secret): chỉ định môi trường liên quan của các secrets cần giải mã, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

list lấy và giải mã tất cả các mục secret/môi trường từ máy chủ.

locker secret list --access-key-id {id} --secret-access-key {secret key} [additional flags]

locker environment list --access-key-id {id} --secret-access-key {secret key} [additional flags]

Lệnh con `get`

Có sẵn trên các lệnh secret và environment.

get lấy và giải mã một mục secret/môi trường cụ thể từ máy chủ.

Cờ bắt buộc:

--key (cho secret) hoặc --name (cho environment): chỉ định khóa/tên của mục muốn giải mã.

Cờ tùy chọn:

--environment (chỉ dành cho secret): chỉ định môi trường liên quan cho secret cần giải mã, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

locker secret get --access-key-id {id} --secret-access-key {secret key} --key {secret's key} --environment {secret's environment} [additional flags]

locker environment get --access-key-id {id} --secret-access-key {secret key} --name {environment's name} [additional flags]

Lệnh con `create`

Có sẵn trên các lệnh secret và environment.

create nhận dữ liệu đầu vào và tạo phiên bản được mã hóa của nó trên máy chủ Locker Secret.

Cờ bắt buộc:

--key, --value (cho secret): cặp key-value của secret.

--name (cho environment): tên môi trường.

Cờ tùy chọn:

--description: mô tả của mục.

--url: URL của môi trường.

--environment (cho secret) chỉ định môi trường mà secret thuộc về.

Lệnh hoàn chỉnh của secret create:

locker secret create --access-key-id {id} --secret-access-key {secret key} --key secret_1 --value secret_2 --description "this is secret data" --environment prod [additional flags]

Lưu ý: Các cờ --key và --value là bắt buộc.

Lệnh hoàn chỉnh của environment create:

locker environment create --access-key-id {id} --secret-access-key {secret key} --name env_1 --url env_2	--description "this is env data" [additional flags]

Lưu ý: Cờ --name là bắt buộc.

Lệnh con `update`

Có sẵn trên các lệnh secret và environment.

update sửa đổi dữ liệu của một secret hoặc môi trường bằng dữ liệu được cung cấp.

Cờ bắt buộc:

--key (cho secret),--name (cho environment): chỉ định mục muốn cập nhật.

Ít nhất một trong số các cờ sau:

--new-key, --new-value, --new-description, --new-environment (cho secret), --new-name, --new-url, --new-description (choenvironment): chỉ định trường thông tin cần sửa đổi. Tên môi trường truyền vào --new-environment phải tồn tại.

Cờ tùy chọn:

--environment (chỉ secret): chỉ định môi trường liên quan cho secret cần cập nhật, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

Cờ --new-* phải được truyền vào từng trường được sửa đổi.

Ví dụ: lệnh secret update cập nhật khóa, giá trị, mô tả và môi trường của một mục bí mật:

locker secret update --access-key-id {id} --secret-access-key {secret key} --key old_secret_1 --environment old_environment_1  --data --new-key new_secret_1 --new-value new_secret_2 --new-description "this is new secret data" --new-environment new_environment_1 [additional flags]

trong khi đó, lệnh dưới đây chỉ cập nhật khóa:

locker secret update --access-key-id {id} --secret-access-key {secret key} --key old_secret_1 --environment old_environment_1  --data --new-key new_secret_1 [additional flags]

Lưu ý: key và một trong các cờ --new-* là bắt buộc.

Lệnh hoàn chỉnh của environment create:

locker environment update --access-key-id {id} --secret-access-key {secret key} --name old_env_1 --new-name new_env_1 --new-url new_env_2 --new-description "this is new env data" [additional flags]

Lưu ý: name và một trong các cờ --new-* là bắt buộc.

Lệnh con `run`

Có sẵn trên các lệnh secret.

run đưa các secrets của một môi trường vào quy trình dòng lệnh dưới dạng biến môi trường.

Cờ bắt buộc:

--command: lệnh thực thi của tiến trình mục tiêu.

Cờ tùy chọn:

--environment: chỉ định môi trường liên quan của secret được đưa vào, mặc định là null (đại diện cho môi trường All) nếu không được cung cấp.

Lệnh hoàn chỉnh của secret run:

locker secret run --access-key-id {id} --secret-access-key {secret key} --environment dev --command

Lưu ý: Cờ --command là bắt buộc.

Lệnh con `import`

Có sẵn trên các lệnh secret.

import đọc các tệp chứa danh sách secrets và nhập các tệp này vào kho lưu trữ của Locker Secrets. Hỗ trợ định dạng dữ liệu .env và config.ini .

Cờ bắt buộc:

--source: đường dẫn tới tệp chứa các secrets cần nhập vào.

Lệnh hoàn chỉnh của secret import:

locker secret import --access-key-id {id} --secret-access-key {secret key} --source /path/to/secret/file

Lưu ý: Cờ --source là bắt buộc.

Lệnh `scan`

Lệnh scan tìm kiếm secret bị lộ trên toàn bộ kho và lịch sử git (nếu tồn tại).

Cờ bắt buộc:

--source : đường dẫn tới kho cần quét.

Lệnh hoàn chỉnh của scan :

locker scan --source /path/to/code/directory

Lưu ý: Cờ --source là bắt buộc.

Lệnh con `fix`

Có sẵn trên các lệnh scan.

fix thực hiện lệnh scan , và tạo một tệp để nhập dữ liệu ở kho đích chứa câu lệnh nhập và khởi tạo ứng dụng khách Locker Secret SDK (dựa trên cờ --language ) và thay thế toàn bộ các secrets đã được phát hiện với các câu lệnh truy xuất secrets của SDK.

Cờ bắt buộc:

--source: đường dẫn tới kho cần quét.

--language : ngôn ngữ của tệp được quét bởi lệnh fix, còn được dùng để chỉ định SDK sẽ được dùng (hiện chỉ hỗ trợ python ).

Lệnh hoàn chỉnh của scan fix:

locker scan fix --source /path/to/code/directory --language python --access-key-id {id} --secret-access-key {secret key}

Lưu ý: Cờ --source và --language là bắt buộc.

Xử lý lỗi

Nếu có vấn đề lớn xảy ra trong quá trình thực thi, Locker Secrets CLI sẽ đưa ra một ngoại lệ và xuất ra một đối tượng lỗi ở dạng sau:

{
	'object': 'error',
	'error': ERROR_CODE,
	'message': DETAILED_ERROR_MESSAGE
}

Locker Secrets CLI dự kiến các loại mã lỗi sau:

"command_error": Lệnh hoặc lệnh con không trả về kết quả hợp lệ.

"function_error": Thư viện chuẩn của Go gặp phải một ngoại lệ.

"flag_error": Người dùng thiếu một hoặc nhiều cờ bắt buộc cho một lệnh hoặc lệnh con.

"input_error": Dữ liệu đầu vào (cờ hoặc dữ liệu của cơ sở dữ liệu) không hợp lệ.

"invalid_secret_access_key": Dữ liệu -access-key-id của người dùng vi phạm định dạng base64.

"data_error": Dữ liệu Base64 bị hỏng.

"server_error": Phản hồi của máy chủ đối với lệnh gọi API là 5XX.

"http_error": Phản hồi của máy chủ đối với lệnh gọi API không phải lỗi 5XX.

"path_error": Lỗi trong quá trình đọc/ghi file.

"database_error": Lỗi trong quá trình vận hành cơ sở dữ liệu.

Kết quả

Cài đặt

Lược đồ dữ liệu của Locker Secrets

Cấu trúc lệnh CLI

Thứ tự ưu tiên của thông tin đăng nhập

Global flags

Lệnh `configuration`

Lệnh `secret`

Lệnh `environment`

Cờ lệnh sử dụng chung cho lệnh `secret` , `environment` và `scan`

Cờ sử dụng chung cho lệnh `secret` và `environment`

Lệnh con `list`

Lệnh con `get`

Lệnh con `create`

Lệnh con `update`

Lệnh con `run`

Lệnh con `import`

Lệnh `scan`

Lệnh con `fix`

Xử lý lỗi

Tham gia cộng đồng của chúng tôi

Tham gia cộng đồng của chúng tôi

Cài đặt

Lược đồ dữ liệu của Locker Secrets

Cấu trúc lệnh CLI

Thứ tự ưu tiên của thông tin đăng nhập

Global flags

Lệnh configuration

Lệnh secret

Lệnh environment

Cờ lệnh sử dụng chung cho lệnh secret , environment và scan

Cờ sử dụng chung cho lệnh secret và environment

Lệnh con list

Lệnh con get

Lệnh con create

Lệnh con update

Lệnh con run

Lệnh con import

Lệnh scan

Lệnh con fix

Xử lý lỗi

Tham gia cộng đồng của chúng tôi

Tham gia cộng đồng của chúng tôi

Lệnh `configuration`

Lệnh `secret`

Lệnh `environment`

Cờ lệnh sử dụng chung cho lệnh `secret` , `environment` và `scan`

Cờ sử dụng chung cho lệnh `secret` và `environment`

Lệnh con `list`

Lệnh con `get`

Lệnh con `create`

Lệnh con `update`

Lệnh con `run`

Lệnh con `import`

Lệnh `scan`

Lệnh con `fix`