Rust SDK

Keeperシークレットマネージャー用Rust SDK資料

ダウンロードとインストール

要件

本SDKの利用にはRust 1.87 以降が必要です。このバージョン要件により、Edition 2024の依存関係との互換性と、直近のセキュリティ修正への対応が確保されます。

Cargoでパッケージ追加

cargo add keeper-secrets-manager-core

詳細については、https://crates.io/crates/keeper-secrets-manager-coreをご参照ください。

Cargo機能

SDKには4つのCargo機能が含まれ、いずれも既定で有効です。より小さなバイナリにする場合は default-features = false を指定します。

機能

既定

説明

blocking

reqwest ブロッキングHTTPクライアント (すべてのネットワーク操作に必要)

totp

TOTPコード生成

password-gen

パスワード生成ユーティリティ

tracing-init

env_logger ベースのログ初期化

特定の機能のみを含める例

[dependencies]
keeper-secrets-manager-core = { version = "17.3.0", default-features = false, features = ["blocking", "password-gen"] }

ソースコード

RustのソースコードについてはGitHubリポジトリをご覧ください。

SDKの使用方法

初期化

トークンのみで新しい設定を生成し、あとから使う場合は、トークンをバインドして config.json を完全に生成するまでに、少なくとも1回の読み取り操作が必要です。

SecretsManager::new(client_options)?

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::FileKeyValueStorage,
    custom_error::KSMRError
};

fn main()-> Result<(), KSMRError>{
    let token = "<Your One time token>".to_string();
    let config = FileKeyValueStorage::new_config_storage("test.json".to_string())?;
    let client_options = ClientOptions::new_client_options_with_token(token, config);
    let mut secrets_manager = SecretsManager::new(client_options)?;
    Ok(())
}

パラメータ

必須

説明

型

token

はい

ワンタイムアクセストークン

String

config

はい

ストレージ設定

KeyValueStorage

バインディングライフサイクル

ワンタイムトークンは、クライアント作成時ではなく、最初の get_secrets() 呼び出し時に引き換えられます。構成を外部ストア (AWS Secrets Manager、Azure Key Vaultなど) に保存する場合は、バインド後に読み出してから永続化します。詳しくは、バインディングライフサイクルをご参照ください。

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::FileKeyValueStorage,
};

// 初回実行: ワンタイムトークンとファイルベースのストアを指定します。
let config = FileKeyValueStorage::new_config_storage("ksm-config.json".to_string())?;
let mut sm = SecretsManager::new(
    ClientOptions::new_client_options_with_token(
        "US:BASE64_ONE_TIME_TOKEN".to_string(),
        config,
    )
)?;
let records = sm.get_secrets(vec![])?;
// ここでトークンが引き換えられ、ksm-config.json がバインド済み認証情報で更新されます。

// 以降の実行: トークンは省略します。保存済みの認証情報が直接使用されます。
let config = FileKeyValueStorage::new_config_storage("ksm-config.json".to_string())?;
let mut sm = SecretsManager::new(
    ClientOptions::new_client_options(config)
)?;
let records = sm.get_secrets(vec![])?;

プロキシ設定

SDKの通信をすべてHTTPまたはHTTPSのプロキシ経由にするには、ClientOptions の proxy_url を設定するか、環境変数を使います。プロキシは、API呼び出し、ファイルのアップロードとダウンロード、サムネイルのダウンロード、キャッシュへのリクエストなど、SDKのすべての操作に適用されます。

let mut client_options = ClientOptions::new_client_options(config);
client_options.proxy_url = Some("http://proxy.example.com:8080".to_string());
let mut secrets_manager = SecretsManager::new(client_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let mut client_options = ClientOptions::new_client_options(config);

    // Authenticated proxy: http://user:pass@host:port
    client_options.proxy_url = Some("http://user:pass@proxy.example.com:8080".to_string());

    let mut secrets_manager = SecretsManager::new(client_options)?;
    let secrets = secrets_manager.get_secrets(Vec::new())?;
    Ok(())
}

オプション

説明

ClientOptions.proxy_url

コードからプロキシを指定 (環境変数より優先)

HTTP_PROXY / HTTPS_PROXY

標準のプロキシ用環境変数 (proxy_url 未設定時に使用)

KSM_PROXY_URL

キャッシュリクエスト用。caching_post_function が使用。make_caching_post_function では未使用。プロキシはファクトリへ渡す reqwest::blocking::Client で設定

ClientOptions.insecure_skip_verify

true で TLS 証明書検証を無効化 (テスト以外は非推奨)

KSM_SKIP_VERIFY

insecure_skip_verify の環境変数版。true で検証をスキップ、false (既定) で検証を実施

カスタムサーバー公開鍵

一部の環境では、SDKに組み込まれていないサーバー公開鍵が使われます。以下の3通りで指定できます。コードから指定する値が最優先されます。

オプション1: 拡張ワンタイムトークン

4セグメント形式 <region>:clientKey:keyId:serverPublicKeyBase64 のトークンを new_client_options_with_token に直接渡します。追加設定は不要です。

オプション2: 構成フィールド

ClientOptions を構築する前に、KSM構成JSONの serverPublicKey (base64urlエンコードのEC公開鍵) を設定します。

オプション3: プログラムから指定

let mut client_options = ClientOptions::new_client_options(config);
client_options.set_server_public_key("BASE64URL_EC_PUBLIC_KEY");
client_options.set_server_public_key_id("KEY_ID");
let mut secrets_manager = SecretsManager::new(client_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let mut client_options = ClientOptions::new_client_options(config);

    client_options.set_server_public_key("BASE64URL_EC_PUBLIC_KEY");
    client_options.set_server_public_key_id("KEY_ID");

    let mut secrets_manager = SecretsManager::new(client_options)?;
    let secrets = secrets_manager.get_secrets(Vec::new())?;
    Ok(())
}

メソッド

説明

set_server_public_key(key_b64: &str)

カスタムEC公開鍵 (base64url) を注入。OTTセグメントと保存済み構成より優先

set_server_public_key_id(key_id: &str)

カスタム公開鍵とともに送信するキーID

カスタム鍵が有効な間は、サーバーから送られる鍵ローテーションのヒントは抑制されます。注入した鍵は標準鍵で上書きされません。

シークレットの取得

KeeperバックエンドがHTTP 403スロットル応答を返した場合、指数バックオフ (11秒、22秒、44秒、88秒、176秒) と ±25% のジッター付きで最大5回まで自動リトライされます。すべて失敗すると KSMRError::Throttled が返されます。この動作を有効にするためのコード変更は不要です。

let records_filter = Vec::new(); // UIDに基づき必要ならレコードフィルターを追加
let secrets = secrets_manager.get_secrets(records_filter)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    custom_error::KSMRError,
    storage::FileKeyValueStorage
};

fn main()-> Result<(), KSMRError>{
    let token = "<Your One time token>".to_string();
    let file_name = FileKeyValueStorage::new_config_storage("test.json".to_string())?;
    let client_options = ClientOptions::new_client_options_with_token(token, file_name);
    
    let mut secrets_manager = SecretsManager::new(client_options)?;
    let secrets = secrets_manager.get_secrets(Vec::new())?;

    for secret in secrets {
        secret.print();
        println!("---");
    }
    Ok(())
}

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    custom_error::KSMRError,
    storage::FileKeyValueStorage
};

fn main()-> Result<(), KSMRError>{
    let token = "<Your One time token>".to_string();
    let file_name = FileKeyValueStorage::new_config_storage("test.json".to_string())?;
    let client_options = ClientOptions::new_client_options_with_token(token, file_name);
    
    let mut secrets_manager = SecretsManager::new(client_options)?;
    let records_filter = vec!["record_uid1".to_string(), "record_uid2".to_string()]; // UIDに基づき必要ならレコードフィルターを追加
    let secrets = secrets_manager.get_secrets(records_filter)?;

    for secret in secrets {
        secret.print();
        println!("---");
    }
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

uids

Vec<String>

はい

Vec::new()

取得するレコードUID。空のベクターを渡すと、アプリケーションがアクセスできるすべてのレコードを取得します。

戻り値

型: Result<Vec<Record>, KSMRError>

すべてのKeeperレコード、または指定したUIDのレコード

デフォルトでは、指定したトークンでアクセス可能なすべてのレコードを取得します

オプション付きでシークレットを取得

GraphSyncによってリンクされたレコードなど、追加データが必要なときは get_secrets_with_options() を使います。

let query_options = QueryOptions::with_links(Vec::new(), Vec::new(), true);
let secrets = secrets_manager.get_secrets_with_options(query_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    dto::payload::QueryOptions,
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // プライマリのシークレットとあわせてリンクされたレコードを要求
    // Vec::new() は UID/フォルダのフィルターなし (全シークレット取得) を表す
    let query_options = QueryOptions::with_links(Vec::new(), Vec::new(), true);
    let secrets = secrets_manager.get_secrets_with_options(query_options)?;

    for secret in &secrets {
        println!("Secret: {}", secret.title);
        if !secret.links.is_empty() {
            println!("  Linked records: {}", secret.links.len());
        }
    }
    Ok(())
}

パラメータ

型

必須

説明

query_options

QueryOptions

はい

リクエストのオプション

QueryOptions のフィールド:

フィールド

型

説明

records_filter

Vec<String>

取得するレコードUID。空のベクターですべてのレコードを取得

folders_filter

Vec<String>

絞り込むフォルダUID。空のベクターではフォルダによる絞り込みなし

request_links

Option<bool>

true のとき、レスポンスに GraphSync によるリンク先レコードを含める。リンク先は Record.links で参照

戻り値

型: Result<Vec<Record>, KSMRError>

クエリオプションに一致するすべてのレコード。

シークレットから値を取得

パスワードを取得

Keeperシークレットマネージャーからシークレットを取得した後に、そのパスワードを参照できます。

secret.get_standard_field_value("password", true);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;
    
    // レコードUIDを指定してシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["record_uid".to_string()])?;
    let secret = match secrets.len(){
        0 => return Err(KSMRError::CustomError("no secret with given uid is found".to_string())),
        _ => &secrets[0],
    };
    // レコードからパスワードを取得
    let my_secret_password = secret.get_standard_field_value("password", true)?;
    Ok(())
}

標準フィールドの取得

secret.get_standard_field_value("FIELD_TYPE", true);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::FileKeyValueStorage,
    custom_error::KSMRError,
    enums::StandardFieldTypeEnum
};

fn main()-> Result<(), KSMRError>{
    // Secrets Managerのセットアップ
    let token = "your_token_goes_here".to_string();
    let config = FileKeyValueStorage::new_config_storage("test.json".to_string())?;
    let client_options = ClientOptions::new_client_options_with_token(token, config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // レコードUIDを指定してシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["record_uid".to_string()])?;
    let secret = match secrets.len(){
        0 => return Err(KSMRError::CustomError("no secret with given uid is found".to_string())),
        _ => &secrets[0],
    };
    // タイプミスを避けるためStandardFieldTypeEnumを使用
    let login_field = StandardFieldTypeEnum::LOGIN.get_type();
    // シークレットからログインフィールドを取得
    let my_secret_login = secret.get_standard_field_value(login_field, true)?;
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

field_type

&str

はい

なし

取得するフィールドタイプ

single

bool

任意

false

最初の値のみを返す

戻り値

型: Result<Value, KSMRError>

JSON形式のフィールド値。single = true のときは最初の値、それ以外は配列を返します。

フィールドタイプはKeeperレコードタイプに基づきます。利用可能なフィールドの詳細な一覧については、コマンダーで record-type-info コマンドをご参照ください。

カスタムフィールドの取得

secret.get_custom_field_value("FIELD_TYPE", true);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // レコードUIDで特定のシークレットを取得する
    let secrets = secrets_manager.get_secrets(vec!["record_uid".to_string()])?;
    let secret = match secrets.len(){
        0 => return Err(KSMRError::CustomError("no secret with given uid is found".to_string())),
        _ => &secrets[0],
    };
    // カスタムフィールドを取得する、例: APIキー
    let api_key = secret.get_custom_field_value("API Key", true)?;
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

field_type

&str

はい

取得するフィールドの型

single

bool

任意

false

最初の値のみを返す

カスタムフィールドはレコードタイプ定義に含まれないフィールドで、ユーザーによって追加できます。

戻り値

型: Result<Value, KSMRError>

JSON形式のフィールド値。single = true のときは最初の値、それ以外は配列を返します。

タイトルでシークレットを検索

レコードタイトルでシークレットを検索する場合、SDKでは以下のAPIを使います。

get_secrets_by_title() — タイトルが完全一致するシークレットをすべて返す
get_secret_by_title() — タイトルが完全一致する最初の1件だけを返す

secrets_manager.get_secrets_by_title(record_title)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // レコードタイトルに一致するすべてのシークレットを取得
    let matching_secrets = secrets_manager.get_secrets_by_title("My Credentials")?;
    println!("Found {} matching secrets", matching_secrets.len());

    Ok(())
}

secrets_manager.get_secret_by_title(record_title)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // レコードタイトルに一致する最初のシークレットを取得
    if let Some(secret) = secrets_manager.get_secret_by_title("My Credentials")? {
        println!("Found secret: {}", secret.uid);
    } else {
        println!("No secret found with that title");
    }

    Ok(())
}

レスポンス

メソッド

戻り値の型

説明

get_secrets_by_title()

Result<Vec<Record>, KSMRError>

タイトルが完全一致するすべてのシークレット

get_secret_by_title()

Result<Option<Record>, KSMRError>

タイトルが完全一致する最初の1件、または None

パラメータ

型

必須

説明

record_title

&str

はい

検索するレコードのタイトル (完全一致)

タイトル照合は大文字小文字を区別し、完全一致が必要です。部分一致や大文字小文字を区別しない検索には、いったんすべてのシークレットを取得し、クライアント側で絞り込んでください。

Keeper表記法を使用して値を取得

secrets_manager.get_notation(query)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // 表記法に一致するすべてのシークレットを取得する
    let notation = "HDQTnxkTcPSOsHNAlbI4aQ/field/login".to_string();
    let result = secrets_manager.get_notation(notation)?;
    Ok(())
}

Keeper表記法の形式と機能については、こちらのページをご参照ください。

パラメーター

型

必須

デフォルト

説明

query

String

はい

指定したフィールドから値を取得するためのKeeper表記法クエリ

戻り値

型: Result<serde_json::Value, KSMRError>

照会したフィールドの値 (JSON形式)。フィールドが単一値のときはJSON文字列に、複数値のときはJSON配列に解決されます。

TOTPコードの取得

get_totp_code(&url)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    enums::StandardFieldTypeEnum,
    utils
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDを指定してシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let record = &secrets[0];

    // レコードからTOTPのURL値を取得
    let value = record.get_standard_field_value(StandardFieldTypeEnum::ONETIMECODE.get_type(), false)?;
    let url: String = utils::get_otp_url_from_value_obj(value)?;

    // TOTPのURLからコードを取得
    let totp = utils::get_totp_code(&url)?;
    println!("{}", totp.get_code());
    Ok(())
}

戻り値

型: Result<TotpCode,KSMRError>

パラメータ

型

必須

説明

url

&str

はい

TOTP URL

PAMレコードタイプ

PAMレコードは record.record_type で識別できます。

for record in &records {
    match record.record_type.as_str() {
        "pamMachine"  => { /* host フィールドが利用可能 */ }
        "pamUser"     => { /* login フィールドが利用可能 */ }
        "pamDatabase" => { /* databaseType フィールドが利用可能 */ }
        _ => {}
    }
}

全11種類のPAMレコードタイプのフィールド定義は、PAMレコードタイプをご参照ください。

リンク済み認証情報

PAMリソースレコードとリンク済み認証情報を含めて取得するには、QueryOptions::with_links と get_secrets_with_options を使います。

use keeper_secrets_manager_core::dto::payload::QueryOptions;

let query = QueryOptions::with_links(vec![], vec![], true);
let records = sm.get_secrets_with_options(query)?;

for record in &records {
    for link in &record.links {
        if let Some(uid) = link.get("recordUid").and_then(|v| v.as_str()) {
            println!("linked UID: {}", uid);
        }
    }
}

リンクを要求しなかった場合、またはリンクが存在しない場合は record.links は空です。

`get_links()` による型付きアクセス

record.get_links() は Vec<KeeperRecordLink> を返し、生のリンクエントリを型付きで包むラッパーです。権限フラグ、認証情報フラグ、構造化された設定を、手動のJSON解析なしに参照できます。元のエントリは link.raw に保持されるため、将来のサーバーバージョンで追加されたフィールドも失われません。

let query = QueryOptions::with_links(vec![], vec![], true);
let records = sm.get_secrets_with_options(query)?;

for record in &records {
    for link in record.get_links() {
        println!("linked UID: {} (path: {:?})", link.record_uid, link.path);
        if link.allows_rotation()  { println!("  rotation allowed"); }
        if link.is_admin_user()    { println!("  admin credential"); }
    }
}

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::payload::QueryOptions,
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut sm = SecretsManager::new(client_options)?;

    let query = QueryOptions::with_links(vec![], vec![], true);
    let records = sm.get_secrets_with_options(query)?;

    for record in &records {
        for link in record.get_links() {
            println!("link: {} (path: {:?})", link.record_uid, link.path);
            println!("  rotation={} connections={} session_recording={}",
                link.allows_rotation(),
                link.allows_connections(),
                link.allows_session_recording());
            println!("  is_admin={} is_iam={}", link.is_admin_user(), link.is_iam_user());
            if let Some(rotation) = link.get_rotation_settings() {
                println!("  rotation settings: {:?}", rotation);
            }
        }
    }
    Ok(())
}

KeeperRecordLink フィールド:

フィールド

型

説明

record_uid

String

リンク先レコードのUID

data

Option<String>

Base64エンコードのリンクメタデータ

path

Option<String>

meta、ai_settings、jit_settings などの識別子

raw

HashMap<String, Value>

元のエントリ全体 (未知のフィールドも保持)

権限フラグ (トップレベルまたはネストされた allowedSettings から読み取り):

メソッド

説明

allows_rotation()

ローテーション許可

allows_connections()

接続許可

allows_port_forwards()

ポートフォワード許可

allows_session_recording()

セッション記録有効

allows_typescript_recording()

TypeScript記録有効

allows_remote_browser_isolation()

リモートブラウザ分離有効

ai_enabled()

AI機能有効

ai_session_terminate()

AIセッション終了有効

rotates_on_termination()

セッション終了時の認証情報ローテーション

認証情報フラグ:

メソッド

説明

is_admin_user()

管理者認証情報

is_launch_credential()

起動用認証情報

is_iam_user()

IAMユーザー

belongs_to()

このレコードに属する認証情報

no_update_services()

サービス更新無効

構造化アクセサ:

メソッド

シグネチャ

説明

get_allowed_settings()

-> Map

allowedSettings オブジェクト (ない場合は空のMap)

get_rotation_settings()

-> Option<Map>

ローテーションスケジュールと複雑さの設定

get_meta_data(record_key)

-> Option<Map>

path == "meta" のリンクからのPAM設定

get_ai_settings_data(record_key)

-> Option<Map>

path == "ai_settings" のAI設定 (AES-GCM暗号化)

get_jit_settings_data(record_key)

-> Option<Map>

path == "jit_settings" のJITプロビジョニング設定 (AES-GCM暗号化)

get_link_data(record_key)

-> Option<Map>

解析済みペイロード全体 (プレーンJSON・暗号化データを自動処理)

各SDK共通の説明は、リンク済み認証情報をご参照ください。

シークレットの更新

レコード更新コマンドは、成功してもローカルのレコードデータ (特に更新後のレコードリビジョン) が更新されないため、すでに更新されたレコードに連続して更新を行うと、リビジョンの不一致により失敗します。各更新バッチの後には、必ず更新されたすべてのレコードを再読み込みしてください。

シークレットを更新

update_secret() メソッドは、レコードを更新する標準的な方法です。

secrets_manager.update_secret(record)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    enums::StandardFieldTypeEnum
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let mut secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let mut secret_to_update = secrets.into_iter().next()
        .ok_or_else(|| KSMRError::CustomError("no secret found with given UID".to_string()))?;

    // フィールド値を更新
    let field_type = StandardFieldTypeEnum::LOGIN.get_type();
    secret_to_update.set_standard_field_value_mut(field_type, "sample@ks.com".into())?;

    // 変更を保存
    secrets_manager.update_secret(secret_to_update)?;
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

record

Record

はい

更新後のフィールド値を含むレコード

レスポンス

Result<(), KSMRError> — 成功またはエラー

トランザクションによるパスワードローテーション

update_secret_with_transaction() メソッドは、新しいパスワードをコミットする前に検証するパスワードローテーションで利用します。

rollback パラメータは名前どおり、true でローテーションをロールバック、false で確定 (コミット) します。新しいパスワードを確定するには false を渡します。

secrets_manager.update_secret_with_transaction(record, UpdateTransactionType::Rotation)?;
// 新しいパスワードを検証...
secrets_manager.complete_transaction(record_uid, false)?; // false = commit, true = rollback

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    enums::StandardFieldTypeEnum,
    dto::payload::UpdateTransactionType
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let mut secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let mut secret_to_update = secrets.into_iter().next()
        .ok_or_else(|| KSMRError::CustomError("no secret found with given UID".to_string()))?;
    let record_uid = secret_to_update.uid.clone();

    // パスワードフィールドを更新
    let field_type = StandardFieldTypeEnum::PASSWORD.get_type();
    secret_to_update.set_standard_field_value_mut(field_type, "NewRotatedPassword123!".into())?;

    // ローテーション用トランザクションを開始
    secrets_manager.update_secret_with_transaction(secret_to_update, UpdateTransactionType::Rotation)?;

    // アプリケーションで新しいパスワードを検証...
    // 成功した場合:
    secrets_manager.complete_transaction(record_uid, false)?; // コミット

    // 検証に失敗した場合:
    // secrets_manager.complete_transaction(record_uid, true)?; // ロールバック

    Ok(())
}

パラメータ

型

必須

説明

record

Record

はい

更新後のフィールド値を含むレコード

transaction_type

UpdateTransactionType

はい

General または Rotation

record_uid

String

はい

トランザクションを確定するレコードのUID

rollback

bool

はい

falseでコミット、trueでロールバック

ファイルリンクの削除

update_secret_with_options() メソッドは、ファイルリンクの削除など、更新内容を細かく指定するときに使います。

let update_options = UpdateOptions::new(
    UpdateTransactionType::General,
    vec!["file-uid-to-remove".to_string()]
);
secrets_manager.update_secret_with_options(record, update_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::payload::{UpdateOptions, UpdateTransactionType}
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let secret_to_update = secrets.into_iter().next()
        .ok_or_else(|| KSMRError::CustomError("no secret found with given UID".to_string()))?;

    // 必要に応じてフィールドを変更...

    // ファイルリンクを削除するための更新オプションを作成
    let update_options = UpdateOptions::new(
        UpdateTransactionType::General,
        vec!["file-uid-to-remove-1".to_string(), "file-uid-to-remove-2".to_string()]
    );

    // レコードを更新し、指定したファイルリンクを削除
    secrets_manager.update_secret_with_options(secret_to_update, update_options)?;

    Ok(())
}

パラメータ

型

必須

デフォルト

説明

record

Record

はい

更新後のフィールド値を含むレコード

update_options

UpdateOptions

はい

高度な更新のオプション

UpdateOptions のフィールド:

フィールド

型

説明

transaction_type

UpdateTransactionType

General または Rotation

links_to_remove

Vec<String>

削除するファイル添付のUID

フィールド値は set_standard_field_value_mut または set_custom_field_value_mut で設定します。

フィールドはタイプ名で識別します。

フィールドタイプの一覧はレコードタイプをご参照ください。複数値を持つフィールドは、リストとして設定します。

ランダムパスワードの生成

generate_password_with_options(password_options);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    enums::StandardFieldTypeEnum,
    utils::{generate_password_with_options, PasswordOptions}
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let mut secret = secrets.into_iter().next()
        .ok_or_else(|| KSMRError::CustomError("no secret found with given UID".to_string()))?;

    // ランダムなパスワードを生成
    let charset: String = "$_!?#".to_string();
    let length = 32;
    let digits = 2;
    let lowercase = 2;
    let uppercase = 2;
    let special_characters = 2;
    let password_options = PasswordOptions::new()
        .length(length)
        .digits(digits)
        .lowercase(lowercase)
        .uppercase(uppercase)
        .special_characters(special_characters)
        .special_characterset(charset);
    let password = generate_password_with_options(password_options)?;

    // 新しいパスワードでレコードを更新
    let field_type = StandardFieldTypeEnum::PASSWORD.get_type();
    secret.set_standard_field_value_mut(field_type, password.into())?;

    // シークレットへの変更を保存
    secrets_manager.update_secret(secret)?;
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

password_options

PasswordOptions

はい

パスワードの構成

special_characterset

String

任意

"""!@#$%()+;<>=?[]{}^.,"""

パスワードに含める特殊文字の集合

length

usize

任意

パスワードの長さ

lowercase

i32

任意

なし

パスワードに含める小文字の数

uppercase

i32

任意

なし

パスワードに含める大文字の数

digits

i32

任意

なし

パスワードに含める数字の数

special_characters

i32

任意

なし

パスワードに含める特殊文字の数

デフォルトでは、各件数パラメータはその文字種の最小件数を表します。負の値にするとちょうどその件数になります (例: .lowercase(-8) で小文字がちょうど8文字)。すべての件数パラメータが負またはゼロ (厳密モード) のときは length は無視され、パスワードの総長は絶対値の合計で決まります。

ファイルのダウンロード

secret.download_file(file_name, path);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let secret = &secrets[0];

    // 所定のパスに保存
    let path = format!("./temp/demo_{}.txt", secret.title);
    secret.download_file("uploaded_file.txt", &path)?;
    Ok(())
}

パラメータ

型

必須

説明

file_name

&str

はい

ダウンロードするファイルの名前、タイトル、またはUID

path

&str

はい

ダウンロード先のパス

戻り値

型: Result<bool, KSMRError>

true — ファイルが見つかり、path に保存された場合。false — レコードに一致する名前・タイトル・UIDのファイルがない場合。

ファイルをディスクに保存

record.files 内の KeeperFile インスタンスでは、save_to_file により (未キャッシュの場合は) ダウンロードと復号済み内容の書き込みを1回の呼び出しで実行できます。引数には &str、String、&Path、PathBuf を指定できます。

file.save_to_file("./output/report.pdf")?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let secret = &secrets[0];

    for mut file in secret.files.clone() {
        let path = format!("./output/{}", file.name);
        file.save_to_file(&path)?;
        println!("Saved: {}", path);
    }
    Ok(())
}

パラメータ

型

必須

説明

path

impl AsRef<Path>

はい

保存先パス (&str、String、&Path、PathBuf)。親ディレクトリの存在が必要

戻り値

型: Result<bool, KSMRError>

成功時は true。レコードの添付ファイルを名前・タイトル・UIDで検索する場合は record.download_file(name, path) を使用

タイトルでファイルをダウンロード

レコードのタイトルと添付ファイル名を指定してダウンロードします。SDKはアクセス可能なレコードのうち record_title に一致するものを探し、そのレコードから file_name の添付を取り出します。

secrets_manager.download_file_by_title(record_title, file_name)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main() -> Result<(), KSMRError> {
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // レコードタイトルとファイル名でダウンロード
    if let Some(file_data) = secrets_manager.download_file_by_title("My Record Title", "report.pdf")? {
        std::fs::write("./report.pdf", &file_data)
            .map_err(|e| KSMRError::CustomError(e.to_string()))?;
        println!("File downloaded successfully");
    } else {
        println!("Record or file not found");
    }
    Ok(())
}

パラメータ

型

必須

説明

record_title

&str

はい

ファイルを含むレコードのタイトル

file_name

&str

はい

ダウンロードする添付ファイル名

戻り値

型: Result<Option<Vec<u8>>, KSMRError>

Ok(Some(bytes)) — 復号済みのファイルデータ (バイト列)
Ok(None) — 一致するタイトルのレコードがない、または一致する名前の添付がない
Err(...) — ダウンロードまたは復号のエラー

ファイルのサムネイルをダウンロード

一部の添付ファイル (特に画像) にはサムネイル用のプレビューがあります。本体ファイルとは別にサムネイルだけを取得できます。

file.get_thumbnail_data()

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let secret = &secrets[0];

    // すべてのファイルのサムネイルをダウンロード
    for mut file in secret.files.clone() {
        if let Some(thumbnail_data) = file.get_thumbnail_data()? {
            let thumbnail_path = format!("./temp/{}_thumb.jpg", file.name);
            std::fs::write(&thumbnail_path, &thumbnail_data)
                .map_err(|e| KSMRError::FileWriteError(thumbnail_path.clone(), e))?;
            println!("Downloaded thumbnail: {}", thumbnail_path);
        } else {
            println!("No thumbnail available for {}", file.name);
        }
    }

    Ok(())
}

戻り値

型: Result<Option<Vec<u8>>, KSMRError>

Ok(Some(bytes)) — サムネイルデータ (通常はJPEG)
Ok(None) — このファイルにサムネイルがない
Err(...) — サムネイルのダウンロードまたは復号エラー

画像ファイル (PNG、JPEG など) ではサムネイルが付くことが多いです。ドキュメントなど非画像のタイプでは、多くの場合サムネイルはありません。

ファイルのアップロード

upload_file(owner_record, keeper_file);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::file::KeeperFileUpload
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDで特定のシークレットを取得
    let secrets = secrets_manager.get_secrets(vec!["<RECORD UID>".to_string()])?;
    let owner_record = &secrets[0];

    // アップロード用にファイルデータを準備
    let file_path = "./local_file.txt";
    let file_name = Some("uploaded_file.txt");
    let file_title = Some("My File");
    let mime_type = Some("text/plain");
    let keeper_file = KeeperFileUpload::get_file_for_upload(
        file_path,
        file_name,
        file_title,
        mime_type
    )?;

    // 所有レコードに添付してアップロードし、ファイルUIDを取得
    let file_uid = secrets_manager.upload_file(owner_record, keeper_file)?;
    println!("Uploaded file UID: {}", file_uid);
    Ok(())
}

ファイルアップロードのパラメータ

パラメータ

型

必須

デフォルト

説明

owner_record

Record

はい

None

ファイルをアップロードするレコード

keeper_file

KeeperFileUpload

はい

アップロードするファイル

ファイルのパラメータ

パラメータ

型

必須

デフォルト

説明

file_path

&str

はい

アップロードするファイルのパス

file_name

Option<&str>

はい

アップロードするファイルの名前

file_title

Option<&str>

はい

アップロードするファイルのタイトル

mime_type

Option<&str>

はい

なし

ファイル内のデータの種類。指定がなければ application/octet-stream が使用されます

戻り値

型: Result<String, KSMRError>

添付ファイルのファイルUID

シークレットの作成

要件

共有フォルダUID
- 共有フォルダはシークレットマネージャーアプリケーションからアクセス可能であること
- あなたとシークレットマネージャーアプリケーションに編集権限があること
- 共有フォルダ内に少なくとも1件のレコードがあること
作成するレコードとレコードフィールドは正しい形式であること
- 各レコードタイプで想定されるフィールド形式は、レコードの作成・更新の手順をご参照ください
TOTPフィールドは、KSM SDKの外部で生成されたURLのみを受け付けます
レコード作成後は upload_file を使って添付ファイルをアップロードできます

複数値フィールド: 1つのフィールドに複数の値を割り当てる場合 (電話番号が2件、セキュリティ質問が2件など) は、JSON配列を RecordField::new_record_field に直接渡します。単一オブジェクトはこれまでどおり自動でラップされます。2件以上ある場合のみ配列を指定してください。

secrets_manager.create_secret(folder_uid, record);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::{dtos::RecordCreate, field_structs::RecordField},
    utils
};
use serde_json::{self, json, Number, Value};

fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // これがRecordを作成する方法です
    let mut created_record =  RecordCreate::new("login".to_string(), "Login Record RUST_LOG_TEST".to_string(), Some("Dummy Notes".to_string()));
    
    // これが単一フィールドを作成する方法です 
    let password_field = RecordField::new_record_field_with_options("password", Value::String(utils::generate_password()?), Some("Random password label".to_string()), false, true);

    // これはすべてのフィールドをベクターに直接作成する一例です
    let fields = vec![
        RecordField::new_record_field("login", Value::String("login@email.com".to_string()), Some("My Custom Login lbl".to_string())),

        password_field,
     ];

    created_record.fields = Some(fields);
  
    // API呼び出しを行う
    let _ = secrets_manager.create_secret("Shared_folder_uid".to_string(), created_record)?;
    Ok(())
}

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::{dtos::RecordCreate, field_structs::RecordField},
    utils
};
use serde_json::{self, json, Number, Value};

fn main()-> Result<(), KSMRError>{
    // setup secrets manager
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // This is how we create a Record
    let mut created_record = RecordCreate::new("login".to_string(), "Login Record RUST_LOG_TEST".to_string(), Some("Dummy Notes".to_string()));

    // This is how we create a single field
    let password_field = RecordField::new_record_field_with_options("password", Value::String(utils::generate_password()?), Some("Random password label".to_string()), false, true);

    // This is one way to create all fields directly in a vector
    let fields = vec![
        RecordField::new_record_field("login", Value::String("login@email.com".to_string()), Some("My Custom Login lbl".to_string())),

        RecordField::new_record_field("login", Value::String("login@email.com".to_string()), Some("My Label".to_string())),

        password_field,

        // Single security question (pass an object for one entry)
        RecordField::new_record_field("securityQuestion", json!({"question": "What is the question?", "answer": "This is the answer!"}), Some("My Security Question".to_string())),

        // Multiple security questions (pass an array for more than one entry)
        RecordField::new_record_field("securityQuestion", json!([
            {"question": "Childhood pet?", "answer": "Fluffy"},
            {"question": "City of birth?", "answer": "Chicago"},
        ]), Some("My Security Questions".to_string())),

        RecordField::new_record_field("multiline", Value::String("This\nIs a multiline\nnote".to_string()), Some("My Multiline lbl".to_string())),

        RecordField::new_record_field("secret", Value::String("SecretText".to_string()), Some("My Hidden Field lbl".to_string())),

        RecordField::new_record_field("pinCode", Value::String("1234567890".to_string()), Some("My Pin Code Field Lbl".to_string())),

        RecordField::new_record_field("addressRef", Value::String("some_UID".to_string()), Some("My Address Reference".to_string())),

        // Single phone number
        RecordField::new_record_field("phone", json!({"region": "US", "number": "510-444-3333"}), Some("My Phone Number".to_string())),

        // Multiple phone numbers (pass an array for more than one entry)
        RecordField::new_record_field("phone", json!([
            {"region": "US", "number": "510-444-3333", "type": "Mobile"},
            {"region": "US", "number": "510-555-6666", "type": "Work"},
        ]), Some("My Phone Numbers".to_string())),

        RecordField::new_record_field("date", Value::Number(Number::from(1641934793000i64)), Some("My date".to_string())),

        RecordField::new_record_field("name", json!({"first": "Lincoln", "last": "Adams"}), Some("His Name".to_string())),
    ];

    // Here we are adding fields object to standard fields
    created_record.fields = Some(fields);

    created_record.custom = Some(
        vec![
            RecordField::new_record_field("phone", json!({"region": "US", "number": "510-222-5555", "ext": "99887", "type": "Mobile"}), Some("My Custom Phone Lbl".to_string())),
        ]
    );

    // Make the API call
    let _ = secrets_manager.create_secret("Shared_folder_uid".to_string(), created_record)?;
    Ok(())
}

パラメータ

型

必須

説明

parent_folder_uid

String

はい

レコードを作成する共有フォルダのUID

record_create_object

RecordCreate

はい

レコード定義 (タイプ、タイトル、フィールド)

RecordCreate のフィールド:

フィールド

型

必須

デフォルト

説明

record_type

String

はい

レコードタイプ (例: "login")

title

String

はい

レコードのタイトル

notes

Option<String>

いいえ

なし

レコードの任意メモ

fields

Vec<RecordField>

いいえ

なし

標準フィールド

custom

Vec<RecordField>

いいえ

なし

カスタムフィールド

戻り値

型: Result<String, KSMRError>

新規レコードのレコードUID

シークレットの削除

Rust KSM SDKでは、Keeperボルト内のレコードを削除できます。

secrets_manager.delete_secret(vec![record_uid]);

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};

fn main() -> Result<(), KSMRError> {
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // UIDを指定してシークレットを削除
    let secret_to_delete = secrets_manager.delete_secret(vec!["<RECORD UID>".to_string()])?;
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

record_uid

Vec<String>

はい

なし

削除対象レコードのUID

戻り値

型: Result<String, KSMRError>

成功時のサーバー応答文字列。

キャッシュ

ネットワークにアクセスできなくなった場合にシークレットへのアクセスを失わないようにするため、Rust SDKではシークレットをローカルマシン上の暗号化ファイルにキャッシュできます。

キャッシュの設定と構成

Rust SDKには、災害復旧用キャッシュとして caching::make_caching_post_function(client) があります。最後に成功したAPIレスポンスをローカルの暗号化ファイルに保存し、サーバーに到達できないときはそのデータへ自動的にフォールバックします。reqwest::blocking::Client は非同期コンテキストの外で一度だけ構築してください (tokio::task::spawn_blocking 内での利用は安全です)。構築したクライアントをファクトリに渡します。ネットワーク接続があるときは、キャッシュよりライブ応答が優先されます。

use keeper_secrets_manager_core::caching;

// Build the client once outside any async context — safe under tokio::spawn_blocking
let http_client = reqwest::blocking::Client::builder().build()?;
let mut client_options = ClientOptions::new_client_options_with_token(token, config);
client_options.set_custom_post_function(caching::make_caching_post_function(http_client));
let mut secrets_manager = SecretsManager::new(client_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::FileKeyValueStorage,
    custom_error::KSMRError,
    caching
};
fn main()-> Result<(), KSMRError>{
    let token = "<Your One time token>".to_string();
    let file_name = FileKeyValueStorage::new_config_storage("test.json".to_string())?;

    let mut client_options = ClientOptions::new_client_options_with_token(token, file_name);

    // Build the client once outside any async context — safe under tokio::spawn_blocking
    let http_client = reqwest::blocking::Client::builder()
        .build()
        .map_err(|e| KSMRError::HTTPError(e.to_string()))?;
    client_options.set_custom_post_function(caching::make_caching_post_function(http_client));

    let mut secrets_manager = SecretsManager::new(client_options)?;

    // 最初の成功した呼び出しがキャッシュに保存される (既定: KSM_CACHE_DIR/ksm_cache.bin)
    let secrets = secrets_manager.get_secrets(Vec::new())?;

    // 以降の呼び出しは、ネットワーク障害時に自動的にキャッシュへフォールバック
    println!("Retrieved {} secrets (with automatic cache fallback)", secrets.len());

    Ok(())
}

キャッシュの保存場所

既定: $KSM_CACHE_DIR/ksm_cache.bin
KSM_CACHE_DIR が未設定の場合はシステムの一時ディレクトリを使用
環境変数で上書き: export KSM_CACHE_DIR=/path/to/cache

既定のキャッシュ関数は最後に成功したリクエストの内容だけを保持します。たとえば、最初のリクエスト (R1) で UID1 を取得してキャッシュを更新したあと、続くリクエスト (R2) で UID2 の取得に失敗すると、キャッシュには UID2 が入りません。そのため、ネットワークが使えないときに UID2 を参照しようとしても、キャッシュに載っていなければ空の結果になります。

キャッシュからレコードを更新する場合 (または新規レコードを作成する場合)、キャッシュされたレコードデータは無効化され、同一レコードへの連続更新は失敗します。バッチ更新は、異なるレコードを変更する限り問題なく動作します。キャッシュ経由でレコードを更新したあとは、必ず get_secrets() を呼び出してキャッシュを更新し、ボルトから新しいレコードリビジョンなどの最新メタデータを取得してください。

カスタムキャッシュの実装

ローカルキャッシュをネットワークより優先する、更新間隔を独自に制御するなど、要件が細かい場合は KSMRCache を基点にキャッシュ処理を実装できます。

use keeper_secrets_manager_core::cache::KSMRCache;

let cache = KSMRCache::new_file_cache(Some("./cache.bin"))?;
let mut client_options = ClientOptions::new_client_options_with_token(token, config);
client_options.set_cache(cache.into());
let mut secrets_manager = SecretsManager::new(client_options)?;

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    custom_error::KSMRError,
    storage::FileKeyValueStorage,
    cache::KSMRCache
};
fn main()-> Result<(), KSMRError>{
    let cache = KSMRCache::new_file_cache(Some("./cache.bin"))?;
    let token = "<Token>".to_string();
    let file_name = FileKeyValueStorage::new_config_storage("test.json".to_string())?;

    let mut client_options = ClientOptions::new_client_options_with_token(token, file_name);
    client_options.set_cache(cache.into());

    let mut secrets_manager = SecretsManager::new(client_options)?;
    let secrets = secrets_manager.get_secrets(Vec::new())?;

    for secret in secrets {
        println!("Secret: {}", secret.title);
    }

    Ok(())
}

フォルダ

フォルダは、作成・読み取り・更新・削除 (CRUD) の全操作に対応しています。

フォルダの読み取り

フォルダ階層全体をダウンロードします。

secrets_manager.get_folders()

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;
    
    // すべてのフォルダを取得
    let folders = secrets_manager.get_folders()?;
    Ok(())
}

戻り値

型: Result<Vec<KeeperFolder>, KSMRError>

フォルダの作成

CreateOptions とフォルダ名の指定が必要です。CreateOptions のフォルダUIDパラメータは必須で、共有フォルダのUIDです。サブフォルダのUIDは任意で、省略すると親 (共有フォルダ) 直下に通常のフォルダが作成されます。サブフォルダが親共有フォルダの直下の子である必要はなく、深い階層にも配置できます。

secrets_manager.create_folder(create_options, folder_name, folders)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::payload::CreateOptions
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // 共有フォルダ直下にフォルダを作成
    let parent_folder_uid = "<PARENT_SHARED_FOLDER_UID>".to_string();
    let create_options = CreateOptions::new(parent_folder_uid, None);
    let new_folder_name = "My New Folder".to_string();

    let folder_uid = secrets_manager.create_folder(create_options, new_folder_name, Vec::new())?;
    println!("Created folder UID: {}", folder_uid);
    Ok(())
}

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::payload::CreateOptions
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // 既存フォルダ内にサブフォルダを作成
    let parent_folder_uid = "<PARENT_SHARED_FOLDER_UID>".to_string();
    let sub_folder_uid = Some("<EXISTING_FOLDER_UID>".to_string());
    let create_options = CreateOptions::new(parent_folder_uid, sub_folder_uid);
    let new_folder_name = "Nested Subfolder".to_string();

    let folder_uid = secrets_manager.create_folder(create_options, new_folder_name, Vec::new())?;
    println!("Created subfolder UID: {}", folder_uid);
    Ok(())
}

パラメータ

型

必須

デフォルト

説明

create_options

CreateOptions

はい

なし

親とサブフォルダのUID

folder_name

String

はい

フォルダ名

folders

Vec<KeeperFolder>

いいえ

なし

CreateOptionsの親/サブフォルダ検索に使用するフォルダ一覧

フォルダの更新

フォルダのメタデータを更新します。現在はフォルダ名のみ更新可能です。

secrets_manager.update_folder(folder_uid, folder_name, folders)

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーのセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    let update_folder = secrets_manager.update_folder("<folder_uid>".to_string(),"dummy_updated_API_RUST".to_string(),Vec::new())?;
    println!("{}",(serde_json::to_string_pretty(&update_folder)?));
    Ok(())
}

パラメータ名

型

必須

デフォルト

説明

folder_uid

String

はい

フォルダUID

folder_name

String

はい

新しいフォルダ名

folders

Vec<KeeperFolder>

いいえ

なし

親フォルダを検索するために使用するフォルダのリスト

戻り値

型: Result<String, KSMRError>

成功時のサーバー応答文字列。

フォルダの削除

フォルダのリストを削除します。force_delete フラグを使うと、空でないフォルダも削除できます。

ボルトに存在しない、またはKSMアプリケーションと共有されていないフォルダUIDがあっても、エラーにはなりません。

force_delete を使用する場合、親フォルダとその子フォルダのUIDを同時に送信しないようにしてください。削除の順序によってはエラーが発生する可能性があります。例えば、親を削除する前に子が強制削除された場合などです。リストが常にFIFO順で処理される保証はありません。

secrets_manager.delete_folder(vec!["<FOLDER_UID>".to_string()], false)?

use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // シークレットマネージャーをセットアップ
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;
    
    let folder_uids = vec!["folder1_uid".to_string(),"folder_2_uid".to_string()];
    secrets_manager.delete_folder(folder_uids, true)?;
    Ok(())
}

パラメータ名

型

必須

デフォルト

説明

folder_uids

Vec<String>

はい

―

フォルダUIDのリスト

force_delete

bool

いいえ

false

true にすると空でないフォルダも削除。既定の false ではレコードを含むフォルダはエラー

戻り値

型: Result<Vec<HashMap<String, Value>>, KSMRError>

削除した各フォルダの応答エントリのリスト。成功時は通常空です。

前へPowerShell

次へボルト用SDK

最終更新 2 か月前

ダウンロードとインストール

要件

Cargoでパッケージ追加

Cargo機能

ソースコード

SDKの使用方法

初期化

バインディングライフサイクル

プロキシ設定

カスタムサーバー公開鍵

シークレットの取得

オプション付きでシークレットを取得

シークレットから値を取得

パスワードを取得

標準フィールドの取得

カスタムフィールドの取得

タイトルでシークレットを検索

Keeper表記法を使用して値を取得

TOTPコードの取得

戻り値

PAMレコードタイプ

リンク済み認証情報

get_links() による型付きアクセス

シークレットの更新

シークレットを更新

トランザクションによるパスワードローテーション

ファイルリンクの削除

ランダムパスワードの生成

ファイルのダウンロード

ファイルをディスクに保存

タイトルでファイルをダウンロード

ファイルのサムネイルをダウンロード

ファイルのアップロード

シークレットの作成

シークレットの削除

キャッシュ

キャッシュの設定と構成

カスタムキャッシュの実装

フォルダ

フォルダの読み取り

フォルダの作成

フォルダの更新

フォルダの削除

`get_links()` による型付きアクセス