keeper_secrets_manager 17.0.4 → 17.2.0

data/examples/09_totp.rb

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-
-# TOTP Example - Generate Time-based One-Time Passwords
-
-require 'keeper_secrets_manager'
-
-# Initialize
-config = ENV['KSM_CONFIG'] || 'YOUR_BASE64_CONFIG'
-secrets_manager = KeeperSecretsManager.from_config(config)
-
-puts "=== TOTP (2FA) Example ==="
-
-# Note: TOTP functionality requires the 'base32' gem
-# Install with: gem install base32
-
-begin
-  # Check if TOTP is available
-  unless defined?(KeeperSecretsManager::Totp)
-    puts "\nTOTP functionality requires the 'base32' gem."
-    puts "Install it with: gem install base32"
-    puts "\nWithout TOTP, you can still:"
-    puts "- Store TOTP seeds in oneTimeCode fields"
-    puts "- Use external authenticator apps"
-    puts "- Access the seed for manual setup"
-    exit
-  end
-
-  puts "\n1. Finding records with TOTP:"
-  secrets = secrets_manager.get_secrets
-  totp_records = secrets.select do |s|
-    s.fields.any? { |f| f['type'] == 'oneTimeCode' }
-  end
-
-  if totp_records.empty?
-    puts "  No records with TOTP found."
-    
-    # Example of creating a record with TOTP
-    puts "\n2. Example: Creating a record with TOTP"
-    puts "  record_data = {"
-    puts "    type: 'login',"
-    puts "    title: '2FA Example',"
-    puts "    fields: ["
-    puts "      { type: 'login', value: ['user@example.com'] },"
-    puts "      { type: 'password', value: ['password123'] },"
-    puts "      { type: 'oneTimeCode', value: ['JBSWY3DPEHPK3PXP'] }"
-    puts "    ]"
-    puts "  }"
-  else
-    puts "  Found #{totp_records.length} records with TOTP"
-    
-    # Generate TOTP codes
-    puts "\n2. Generating TOTP codes:"
-    totp_records.each do |record|
-      totp_field = record.fields.find { |f| f['type'] == 'oneTimeCode' }
-      if totp_field && totp_field['value']
-        seed = totp_field['value'].first
-        
-        # Generate current code
-        code = KeeperSecretsManager::Totp.generate(seed)
-        puts "  #{record.title}: #{code}"
-        
-        # Show time remaining
-        time_remaining = 30 - (Time.now.to_i % 30)
-        puts "    Valid for: #{time_remaining} seconds"
-      end
-    end
-  end
-
-  puts "\n3. Using TOTP via notation:"
-  if totp_records.any?
-    uid = totp_records.first.uid
-    begin
-      totp_url = secrets_manager.get_notation("keeper://#{uid}/field/oneTimeCode")
-      puts "  TOTP URL: #{totp_url}"
-    rescue => e
-      puts "  Error: #{e.message}"
-    end
-  end
-
-  puts "\n4. TOTP URL format:"
-  puts "  Standard TOTP seeds can be imported from URLs:"
-  puts "  otpauth://totp/Example:user@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Example"
-
-  puts "\n5. Manual TOTP setup:"
-  puts "  If base32 gem is not available:"
-  puts "  1. Store the seed in a oneTimeCode field"
-  puts "  2. Use the seed with Google Authenticator or similar"
-  puts "  3. Or install base32 gem for SDK generation"
-
-rescue => e
-  puts "Error: #{e.message}"
-  puts "\nMake sure 'base32' gem is installed for TOTP support"
-end
-
-puts "\n=== TOTP Tips ==="
-puts "- TOTP codes change every 30 seconds"
-puts "- Store TOTP seeds in oneTimeCode fields"
-puts "- Seeds are typically base32 encoded"
-puts "- Compatible with Google Authenticator"
-puts "- Keep TOTP seeds secure like passwords"

data/examples/README.md

@@ -1,89 +0,0 @@
-# Keeper Secrets Manager Ruby SDK Examples
-
-This directory contains examples demonstrating various features of the Keeper Secrets Manager Ruby SDK.
-
-## Prerequisites
-
-1. Set up your configuration using one of these methods:
-   - Token: `export KSM_TOKEN='your_token_here'`
-   - Base64 Config: `export KSM_CONFIG='your_base64_config_here'`
-
-2. Install the SDK:
-   ```bash
-   gem install keeper_secrets_manager
-   ```
-
-## Examples
-
-### 01_quick_start.rb
-Basic connection and simple secret retrieval. Start here if you're new to the SDK.
-
-### 02_authentication.rb
-Different ways to authenticate with Keeper Secrets Manager:
-- Using token authentication
-- Using base64 configuration string
-
-### 03_retrieve_secrets.rb
-Various methods to retrieve secrets:
-- Get all secrets
-- Get by UID
-- Get by title
-- Access specific fields
-- Using Keeper Notation
-
-### 04_create_update_delete.rb
-CRUD operations for managing secrets:
-- Create new records
-- Update existing records
-- Delete records
-- Batch operations tips
-
-### 05_field_types.rb
-Working with different Keeper field types:
-- Standard fields (login, password, URL)
-- Complex fields (name, address, phone)
-- Custom fields
-- Special fields (payment cards, bank accounts)
-
-### 06_files.rb
-File attachment operations:
-- Download files from records
-- Upload files to records
-- Handle different file types
-
-### 07_folders.rb
-Folder management:
-- List folders
-- Create folders and subfolders
-- Move records between folders
-- Get folder hierarchy
-- Delete folders
-
-### 08_notation.rb
-Using Keeper Notation for quick access:
-- Access fields with URI-style notation
-- Use in configuration templates
-- Access custom fields and files
-
-### 09_totp.rb
-Time-based One-Time Passwords (2FA):
-- Generate TOTP codes
-- Store TOTP seeds
-- Integration with authenticator apps
-
-## Running Examples
-
-Each example can be run directly:
-
-```bash
-ruby 01_quick_start.rb
-```
-
-Make sure your environment variables are set before running the examples.
-
-## Security Notes
-
-- Never hardcode credentials in your code
-- Use environment variables for configuration
-- Keep your tokens and configurations secure
-- Don't commit credentials to version control