nano-bots 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f9a6021523f5e49b4349b2d3010c6c147aa81f00e7e0cb21a33e75e59b6f67
-  data.tar.gz: 0745255f21ed6786ceec74ac0b7dad6e431a36c05ecc69d1c8601b1c546694de
+  metadata.gz: 4632306b0fe1fc9af4ee96c7624f163d80c70eb259c80f3efad158e95e76414a
+  data.tar.gz: a2156c47648e3b8b118a4698d23031ca4bd4bf139db6f5f19fa5561f1591cf7b
 SHA512:
-  metadata.gz: 208b13813f692bbb3bb7121e553a95df7a88785964e6ccaaef1e4b1a72086a989c46a8c17930e2f6a9ea3cf18a5906b90f37b9d021e2d66ba1d06c072a122587
-  data.tar.gz: 3aaae5b79c7596b4cd20b1d15687986538573bfd944343129441f5033058d3ce6ff23664c29253a5768a8dcca6ea7385c90acdc16bfb2c72ed0eabad93fb3160
+  metadata.gz: d8271268413e87793b147385c999edddbb59dc70203dfca243adb7836ee680dc430a57dc625d038394b6b86e3bb0a9a4e45f12291f9e1ef9574da8ee69ed93e5
+  data.tar.gz: 1d6d1118162ed3dbc3438205aa7b4e858499d154e7cc6bdba963a53ddeeff7c071398e9eebc1f3d273c7aa128c39fbcb452a8f6f9bfff8d41b2dac81fb04d9ce

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    nano-bots (0.0.9)
+    nano-bots (0.1.0)
       babosa (~> 2.0)
       dotenv (~> 2.8, >= 2.8.1)
       faraday (~> 2.7, >= 2.7.5)
       pry (~> 0.14.2)
       rainbow (~> 3.1, >= 3.1.1)
+      rbnacl (~> 7.1, >= 7.1.1)
       ruby-openai (~> 4.0)
       sweet-moon (~> 0.0.7)
 
@@ -35,6 +36,8 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
+    rbnacl (7.1.1)
+      ffi
     regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -50,7 +53,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rubocop (1.52.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -60,7 +63,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)

data/README.md

@@ -13,6 +13,11 @@ https://user-images.githubusercontent.com/113217272/238141567-c58a240c-7b67-4b3b
   - [Command Line](#command-line)
   - [Library](#library)
 - [Cartridges](#cartridges)
+  - [Marketplace](#marketplace)
+- [Security and Privacy](#security-and-privacy)
+  - [Cryptography](#cryptography)
+  - [End-user IDs](#end-user-ids)
+  - [Decrypting](#decrypting)
 - [Providers](#providers)
 - [Debugging](#debugging)
 - [Development](#development)
@@ -23,13 +28,13 @@ https://user-images.githubusercontent.com/113217272/238141567-c58a240c-7b67-4b3b
 For a system usage:
 
 ```sh
-gem install nano-bots -v 0.0.9
+gem install nano-bots -v 0.1.0
 ```
 
 To use it in a project, add it to your `Gemfile`:
 
 ```ruby
-gem 'nano-bots', '~> 0.0.9'
+gem 'nano-bots', '~> 0.1.0'
 ```
 
 ```sh
@@ -40,8 +45,10 @@ For credentials and configurations, relevant environment variables can be set in
 
 ```sh
 export OPENAI_API_ADDRESS=https://api.openai.com
-export OPENAI_API_ACCESS_TOKEN=your-token
-export OPENAI_API_USER_IDENTIFIER=your-user
+export OPENAI_API_KEY=your-access-token
+
+export NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+export NANO_BOTS_END_USER=your-user
 
 # export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
 # export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
@@ -51,8 +58,10 @@ Alternatively, if your current directory has a `.env` file with the environment
 
 ```sh
 OPENAI_API_ADDRESS=https://api.openai.com
-OPENAI_API_ACCESS_TOKEN=your-token
-OPENAI_API_USER_IDENTIFIER=your-user
+OPENAI_API_KEY=your-access-token
+
+NANO_BOTS_ENCRYPTION_PASSWORD=UNSAFE
+NANO_BOTS_END_USER=your-user
 
 # NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots
 # NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges
@@ -76,14 +85,15 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "gem install nano-bots -v 0.0.9 && bash"
+    command: sh -c "gem install nano-bots -v 0.1.0 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
-      OPENAI_API_ACCESS_TOKEN: your-token
-      OPENAI_API_USER_IDENTIFIER: your-user
+      OPENAI_API_KEY: your-access-token
+      NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
+      NANO_BOTS_END_USER: your-user
     volumes:
-      - ./your-cartridges:/cartridges
-      # - ./your-data:/data
+      - ./your-cartridges:/.local/share/nano-bots/cartridges
+      - ./your-state:/.local/state/nano-bots
 ```
 
 Enter the container:
@@ -96,8 +106,8 @@ Start playing:
 nb - - eval "hello"
 nb - - repl
 
-nb cartridges/assistant.yml - eval "hello"
-nb cartridges/assistant.yml - repl
+nb assistant.yml - eval "hello"
+nb assistant.yml - repl
 ```
 
 ## Usage
@@ -248,19 +258,129 @@ behaviors:
     directive: You are a helpful assistant.
 
 provider:
-  name: openai
+  id: openai
+  credentials:
+    address: ENV/OPENAI_API_ADDRESS
+    access-token: ENV/OPENAI_API_KEY
   settings:
+    user: ENV/NANO_BOTS_END_USER
     model: gpt-3.5-turbo
-    credentials:
-      address: ENV/OPENAI_API_ADDRESS
-      access-token: ENV/OPENAI_API_ACCESS_TOKEN
-      user-identifier: ENV/OPENAI_API_USER_IDENTIFIER
 ```
 
 Check the Nano Bots specification to learn more about [how to build cartridges](https://spec.nbots.io/#/README?id=cartridges).
 
 Try the [Nano Bots Clinic (Live Editor)](https://clinic.nbots.io) to learn about creating Cartridges.
 
+### Marketplace
+
+You can explore the Nano Bots [Marketplace](https://nbots.io) to discover new Cartridges that can help you.
+
+## Security and Privacy
+
+Each provider will have its own security and privacy policies (e.g. [OpenAI Policy](https://openai.com/policies/api-data-usage-policies)), so you must consult them to understand their implications.
+
+### Cryptography
+
+By default, all states stored in your local disk are encrypted.
+
+To ensure that the encryption is secure, you need to define a password through the `NANO_BOTS_ENCRYPTION_PASSWORD` environment variable. Otherwise, although the content will be encrypted, anyone would be able to decrypt it without a password.
+
+It's important to note that the content shared with providers, despite being transmitted over secure connections (e.g., [HTTPS](https://en.wikipedia.org/wiki/HTTPS)), will be readable by the provider. This is because providers need to operate on the data, which would not be possible if the content was encrypted beyond HTTPS. So, the data stored locally on your system is encrypted, which does not mean that what you share with providers will not be readable by them.
+
+To ensure that your encryption and password are configured properly, you can run the following command:
+```sh
+nb security
+```
+
+Which should return:
+```text
+✅ Encryption is enabled and properly working.
+     This means that your data is stored in an encrypted format on your disk.
+
+✅ A password is being used for the encrypted content.
+     This means that only those who possess the password can decrypt your data.
+```
+
+Alternatively, you can check it at runtime with:
+```ruby
+require 'nano-bots'
+
+NanoBot.security.check
+# => { encryption: true, password: true }
+```
+
+#### End-user IDs
+
+A common strategy for deploying Nano Bots to multiple users through APIs or automations is to assign a unique [end-user ID](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids) for each user. This can be useful if any of your users violate the provider's policy due to abusive behavior. By providing the end-user ID, you can unravel that even though the activity originated from your API Key, the actions taken were not your own.
+
+You can define custom end-user identifiers in the following way:
+
+```ruby
+NanoBot.new(environment: { NANO_BOTS_END_USER: 'custom-user-a' })
+NanoBot.new(environment: { NANO_BOTS_END_USER: 'custom-user-b' })
+```
+
+Consider that you have the following end-user identifier in your environment:
+```sh
+NANO_BOTS_END_USER=your-name
+```
+
+Or a configuration in your Cartridge:
+```yml
+---
+provider:
+  id: openai
+  settings:
+    user: your-name
+```
+
+The requests will be performed as follows:
+
+```ruby
+NanoBot.new(cartridge: '-')
+# { user: 'your-name' }
+
+NanoBot.new(cartridge: '-', environment: { NANO_BOTS_END_USER: 'custom-user-a' })
+# { user: 'custom-user-a' }
+
+NanoBot.new(cartridge: '-', environment: { NANO_BOTS_END_USER: 'custom-user-b' })
+# { user: 'custom-user-b' }
+```
+
+Actually, to enhance privacy, neither your user nor your users' identifiers will be shared in this way. Instead, they will be encrypted before being shared with the provider:
+
+```ruby
+'your-name'
+# _O7OjYUESagb46YSeUeSfSMzoO1Yg0BZqpsAkPg4j62SeNYlgwq3kn51Ob2wmIehoA==
+
+'custom-user-a'
+# _O7OjYUESagb46YSeUeSfSMzoO1Yg0BZJgIXHCBHyADW-rn4IQr-s2RvP7vym8u5tnzYMIs=
+
+'custom-user-b'
+# _O7OjYUESagb46YSeUeSfSMzoO1Yg0BZkjUwCcsh9sVppKvYMhd2qGRvP7vym8u5tnzYMIg=
+```
+
+In this manner, you possess identifiers if required, however, their actual content can only be decrypted by you via your secure password (`NANO_BOTS_ENCRYPTION_PASSWORD`).
+
+## Decrypting
+
+To decrypt your encrypted data, once you have properly configured your password, you can simply run:
+
+```ruby
+require 'nano-bots'
+
+NanoBot.security.decrypt('_O7OjYUESagb46YSeUeSfSMzoO1Yg0BZqpsAkPg4j62SeNYlgwq3kn51Ob2wmIehoA==')
+# your-name
+
+NanoBot.security.decrypt('_O7OjYUESagb46YSeUeSfSMzoO1Yg0BZJgIXHCBHyADW-rn4IQr-s2RvP7vym8u5tnzYMIs=')
+# custom-user-a
+
+NanoBot.security.decrypt('_O7OjYUESagb46YSeUeSfSMzoO1Yg0BZkjUwCcsh9sVppKvYMhd2qGRvP7vym8u5tnzYMIg=')
+# custom-user-b
+```
+
+If you lose your password, you lose your data. It is not possible to recover it at all. For real.
+
 ## Providers
 
 Currently supported providers:
@@ -288,5 +408,5 @@ gem build nano-bots.gemspec
 
 gem signin
 
-gem push nano-bots-0.0.9.gem
+gem push nano-bots-0.1.0.gem
 ```

data/components/crypto.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'rbnacl'
+require 'base64'
+
+module NanoBot
+  module Components
+    class Crypto
+      include Singleton
+
+      def initialize
+        password = ENV.fetch('NANO_BOTS_ENCRYPTION_PASSWORD', nil)
+
+        password = 'UNSAFE' unless password && password != ''
+
+        @box = RbNaCl::SecretBox.new(RbNaCl::Hash.sha256(password))
+        @fixed_nonce = RbNaCl::Hash.sha256(password)[0...@box.nonce_bytes]
+      end
+
+      def encrypt(content, soft: false)
+        nonce = soft ? @fixed_nonce : RbNaCl::Random.random_bytes(@box.nonce_bytes)
+        Base64.urlsafe_encode64(nonce + @box.encrypt(nonce, content))
+      end
+
+      def decrypt(content)
+        decoded_content = Base64.urlsafe_decode64(content)
+        nonce = decoded_content[0...@box.nonce_bytes]
+        cipher_text = decoded_content[@box.nonce_bytes..]
+
+        @box.decrypt(nonce, cipher_text)
+      end
+
+      def self.encrypt(content, soft: false)
+        instance.encrypt(content, soft:)
+      end
+
+      def self.decrypt(content)
+        instance.decrypt(content)
+      end
+    end
+  end
+end

data/components/provider.rb

@@ -7,12 +7,12 @@ require_relative './providers/openai'
 module NanoBot
   module Components
     class Provider
-      def self.new(provider)
-        case provider[:name]
+      def self.new(provider, environment: {})
+        case provider[:id]
         when 'openai'
-          Providers::OpenAI.new(provider[:settings])
+          Providers::OpenAI.new(provider[:settings], provider[:credentials], environment:)
         else
-          raise "Unsupported provider #{provider[:name]}"
+          raise "Unsupported provider \"#{provider[:id]}\""
         end
       end
     end

data/components/providers/base.rb

@@ -6,6 +6,10 @@ module NanoBot
   module Components
     module Providers
       class Base
+        def initialize(_settings, _credentials, _environment: {})
+          raise NoMethodError, "The 'initialize' method is not implemented for the current provider."
+        end
+
         def evaluate(_payload)
           raise NoMethodError, "The 'evaluate' method is not implemented for the current provider."
         end

data/components/providers/openai.rb

@@ -3,11 +3,14 @@
 require 'openai'
 
 require_relative './base'
+require_relative '../crypto'
 
 module NanoBot
   module Components
     module Providers
       class OpenAI < Base
+        DEFAULT_ADDRESS = 'https://api.openai.com'
+
         CHAT_SETTINGS = %i[
           model stream temperature top_p n stop max_tokens
           presence_penalty frequency_penalty logit_bias
@@ -15,13 +18,18 @@ module NanoBot
 
         attr_reader :settings
 
-        def initialize(settings)
+        def initialize(settings, credentials, environment: {})
           @settings = settings
+          @credentials = credentials
+          @environment = environment
 
-          @client = ::OpenAI::Client.new(
-            uri_base: "#{@settings[:credentials][:address].sub(%r{/$}, '')}/",
-            access_token: @settings[:credentials][:'access-token']
-          )
+          uri_base = if @credentials[:address].nil? || @credentials[:address].to_s.strip.empty?
+                       "#{DEFAULT_ADDRESS}/"
+                     else
+                       "#{@credentials[:address].to_s.sub(%r{/$}, '')}/"
+                     end
+
+          @client = ::OpenAI::Client.new(uri_base:, access_token: @credentials[:'access-token'])
         end
 
         def stream(input)
@@ -46,11 +54,7 @@ module NanoBot
             )
           end
 
-          payload = {
-            model: @settings[:model],
-            user: @settings[:credentials][:'user-identifier'],
-            messages:
-          }
+          payload = { user: OpenAI.end_user(@settings, @environment), messages: }
 
           CHAT_SETTINGS.each do |key|
             payload[key] = @settings[key] if @settings.key?(key)
@@ -80,6 +84,27 @@ module NanoBot
             block.call({ who: 'AI', message: result.dig('choices', 0, 'message', 'content') }, true)
           end
         end
+
+        def self.end_user(settings, environment)
+          user = ENV.fetch('NANO_BOTS_END_USER', nil)
+
+          user = settings[:user] if !settings[:user].nil? && !settings[:user].to_s.strip.empty?
+
+          candidate = environment && (
+            environment['NANO_BOTS_END_USER'] ||
+            environment[:NANO_BOTS_END_USER]
+          )
+
+          user = candidate if !candidate.nil? && !candidate.to_s.strip.empty?
+
+          user = if user.nil? || user.to_s.strip.empty?
+                   'unknown'
+                 else
+                   user.to_s.strip
+                 end
+
+          Crypto.encrypt(user, soft: true)
+        end
       end
     end
   end

data/components/storage.rb

@@ -3,11 +3,37 @@
 require 'babosa'
 
 require_relative '../logic/helpers/hash'
+require_relative './crypto'
 
 module NanoBot
   module Components
     class Storage
-      def self.build_path_and_ensure_state_file!(key, cartridge)
+      def self.end_user(cartridge, environment)
+        user = ENV.fetch('NANO_BOTS_END_USER', nil)
+
+        if cartridge[:provider][:id] == 'openai' &&
+           !cartridge[:provider][:settings][:user].nil? &&
+           !cartridge[:provider][:settings][:user].to_s.strip.empty?
+          user = cartridge[:provider][:settings][:user]
+        end
+
+        candidate = environment && (
+          environment['NANO_BOTS_END_USER'] ||
+          environment[:NANO_BOTS_END_USER]
+        )
+
+        user = candidate if !candidate.nil? && !candidate.to_s.strip.empty?
+
+        user = if user.nil? || user.to_s.strip.empty?
+                 'unknown'
+               else
+                 user.to_s.strip
+               end
+
+        Crypto.encrypt(user, soft: true)
+      end
+
+      def self.build_path_and_ensure_state_file!(key, cartridge, environment: {})
         path = [
           Logic::Helpers::Hash.fetch(cartridge, %i[state directory]),
           ENV.fetch('NANO_BOTS_STATE_DIRECTORY', nil)
@@ -17,14 +43,23 @@ module NanoBot
 
         path = "#{user_home!.sub(%r{/$}, '')}/.local/state/nano-bots" if path.nil?
 
-        path = "#{path.sub(%r{/$}, '')}/ruby-nano-bots/#{cartridge[:meta][:author].to_slug.normalize}"
+        path = "#{path.sub(%r{/$}, '')}/ruby-nano-bots"
+
+        path = "#{path}/#{cartridge[:meta][:author].to_slug.normalize}"
         path = "#{path}/#{cartridge[:meta][:name].to_slug.normalize}"
-        path = "#{path}/#{cartridge[:meta][:version].to_s.gsub('.', '-').to_slug.normalize}/#{key}"
+        path = "#{path}/#{cartridge[:meta][:version].to_s.gsub('.', '-').to_slug.normalize}"
+        path = "#{path}/#{end_user(cartridge, environment)}"
+        path = "#{path}/#{Crypto.encrypt(key, soft: true)}"
         path = "#{path}/state.json"
 
         FileUtils.mkdir_p(File.dirname(path))
 
-        File.write(path, JSON.generate({ key:, history: [] })) unless File.exist?(path)
+        unless File.exist?(path)
+          File.write(
+            path,
+            Crypto.encrypt(JSON.generate({ key:, history: [] }))
+          )
+        end
 
         path
       end

data/controllers/cartridges.rb

@@ -39,7 +39,7 @@ module NanoBot
         rescue StandardError => _e
         end
 
-        cartridges.sort_by { |cartridge| cartridge[:meta][:name] }
+        cartridges = cartridges.sort_by { |cartridge| cartridge[:meta][:name] }
 
         cartridges.prepend(
           { system: { id: '-' }, meta: { name: 'Default', symbol: '🤖' } }

data/controllers/instance.rb

@@ -13,14 +13,16 @@ require_relative './session'
 module NanoBot
   module Controllers
     class Instance
-      def initialize(cartridge_path:, stream:, state: nil)
+      def initialize(cartridge_path:, stream:, state: nil, environment: {})
         @stream = stream
 
         load_cartridge!(cartridge_path)
 
-        provider = Components::Provider.new(@cartridge[:provider])
+        provider = Components::Provider.new(@cartridge[:provider], environment:)
 
-        @session = Session.new(provider:, cartridge: @cartridge, state:, stream: @stream)
+        @session = Session.new(
+          provider:, cartridge: @cartridge, state:, stream: @stream, environment:
+        )
       end
 
       def cartridge

data/controllers/interfaces/cli.rb

@@ -11,6 +11,28 @@ module NanoBot
           case ARGV[0]
           when 'version'
             puts NanoBot::GEM[:version]
+            exit
+          when 'security'
+            result = NanoBot.security.check
+
+            if result[:encryption]
+              puts "\n✅ Encryption is enabled and properly working."
+              puts '     This means that your data is stored in an encrypted format on your disk.'
+            else
+              puts "\n❌ Encryption is not being utilized to store your content."
+              puts '     This means that your data can be easily read because it is stored in plaintext.'
+            end
+
+            if result[:password]
+              puts "\n✅ A password is being used for the encrypted content."
+              puts '     This means that only those who possess the password can decrypt your data.'
+            else
+              puts "\n❌ No custom password is being used for the encrypted content."
+              puts '     This means that anyone can easily decrypt your data.'
+            end
+
+            puts ''
+
             exit
           when 'help', '', nil
             puts ''
@@ -34,6 +56,7 @@ module NanoBot
             puts '  nb - STATE-KEY state'
             puts '  nb cartridge.yml STATE-KEY state'
             puts ''
+            puts '  nb security'
             puts '  nb version'
             puts '  nb help'
             puts ''

data/controllers/interfaces/eval.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'pry'
-require 'rainbow'
-
-require_relative '../../logic/helpers/hash'
 require_relative '../../logic/cartridge/affixes'
 
 module NanoBot

data/controllers/security.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../components/crypto'
+
+module NanoBot
+  module Controllers
+    module Security
+      def self.decrypt(content)
+        Components::Crypto.decrypt(content)
+      end
+
+      def self.encrypt(content, soft: false)
+        Components::Crypto.encrypt(content, soft:)
+      end
+
+      def self.check
+        password = ENV.fetch('NANO_BOTS_ENCRYPTION_PASSWORD', nil)
+        password = 'UNSAFE' unless password && password != ''
+
+        {
+          encryption: (
+            Components::Crypto.encrypt('SAFE') != 'SAFE' &&
+            Components::Crypto.encrypt('SAFE') != Components::Crypto.encrypt('SAFE') &&
+            Components::Crypto.decrypt(Components::Crypto.encrypt('SAFE')) == 'SAFE'
+          ),
+          password: password != 'UNSAFE'
+        }
+      end
+    end
+  end
+end

data/controllers/session.rb

@@ -9,6 +9,7 @@ require_relative '../logic/cartridge/streaming'
 require_relative '../logic/cartridge/interaction'
 require_relative '../components/storage'
 require_relative '../components/adapter'
+require_relative '../components/crypto'
 
 module NanoBot
   module Controllers
@@ -17,7 +18,7 @@ module NanoBot
     class Session
       attr_accessor :stream
 
-      def initialize(provider:, cartridge:, state: nil, stream: $stdout)
+      def initialize(provider:, cartridge:, state: nil, stream: $stdout, environment: {})
         @stream = stream
         @provider = provider
         @cartridge = cartridge
@@ -28,8 +29,9 @@ module NanoBot
           @state = { history: [] }
         else
           @state_path = Components::Storage.build_path_and_ensure_state_file!(
-            state.strip, @cartridge
+            state.strip, @cartridge, environment:
           )
+
           @state = load_state
         end
       end
@@ -39,11 +41,13 @@ module NanoBot
       end
 
       def load_state
-        @state = Logic::Helpers::Hash.symbolize_keys(JSON.parse(File.read(@state_path)))
+        @state = Logic::Helpers::Hash.symbolize_keys(JSON.parse(
+                                                       Components::Crypto.decrypt(File.read(@state_path))
+                                                     ))
       end
 
       def store_state!
-        File.write(@state_path, JSON.generate(@state))
+        File.write(@state_path, Components::Crypto.encrypt(JSON.generate(@state)))
       end
 
       def boot(mode:)

data/docker-compose.example.yml

@@ -3,11 +3,12 @@ version: '3.7'
 services:
   nano-bots:
     image: ruby:3.2.2-slim-bullseye
-    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev lua5.4-dev && gem install nano-bots -v 0.0.9 && bash"
+    command: sh -c "apt-get update && apt-get install -y --no-install-recommends build-essential libffi-dev libsodium-dev lua5.4-dev && gem install nano-bots -v 0.1.0 && bash"
     environment:
       OPENAI_API_ADDRESS: https://api.openai.com
-      OPENAI_API_ACCESS_TOKEN: your-token
-      OPENAI_API_USER_IDENTIFIER: your-user
+      OPENAI_API_KEY: your-access-token
+      NANO_BOTS_ENCRYPTION_PASSWORD: UNSAFE
+      NANO_BOTS_END_USER: your-user
     volumes:
-      - ./your-cartridges:/cartridges
-      # - ./your-data:/data
+      - ./your-cartridges:/.local/share/nano-bots/cartridges
+      - ./your-state:/.local/state/nano-bots

data/nano-bots.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 2.7', '>= 2.7.5'
   spec.add_dependency 'pry', '~> 0.14.2'
   spec.add_dependency 'rainbow', '~> 3.1', '>= 3.1.1'
+  spec.add_dependency 'rbnacl', '~> 7.1', '>= 7.1.1'
   spec.add_dependency 'ruby-openai', '~> 4.0'
   spec.add_dependency 'sweet-moon', '~> 0.0.7'
 

data/ports/dsl/nano-bots.rb

@@ -5,12 +5,22 @@ require 'dotenv/load'
 require_relative '../../static/gem'
 require_relative '../../controllers/cartridges'
 require_relative '../../controllers/instance'
+require_relative '../../controllers/security'
 require_relative '../../controllers/interfaces/cli'
 require_relative '../../components/stream'
 
 module NanoBot
-  def self.new(cartridge: '-', state: '-')
-    Controllers::Instance.new(cartridge_path: cartridge, state:, stream: Components::Stream.new)
+  def self.new(cartridge: '-', state: '-', environment: {})
+    Controllers::Instance.new(
+      cartridge_path: cartridge,
+      state:,
+      stream: Components::Stream.new,
+      environment:
+    )
+  end
+
+  def self.security
+    Controllers::Security
   end
 
   def self.cartridges
@@ -21,8 +31,10 @@ module NanoBot
     Controllers::Interfaces::CLI.handle!
   end
 
-  def self.repl(cartridge: '-', state: '-')
-    Controllers::Instance.new(cartridge_path: cartridge, state:, stream: $stdout).repl
+  def self.repl(cartridge: '-', state: '-', environment: {})
+    Controllers::Instance.new(
+      cartridge_path: cartridge, state:, stream: $stdout, environment:
+    ).repl
   end
 
   def self.version

data/static/cartridges/baseline.yml

@@ -1,14 +1,17 @@
 ---
 meta:
+  symbol: 🤖
   name: Unknown
-  author: Nobody
+  author: None
   version: 0.0.0
+  license: CC0-1.0
+  description: Unknown
 
 provider:
-  name: openai
+  id: openai
+  credentials:
+    address: ENV/OPENAI_API_ADDRESS
+    access-token: ENV/OPENAI_API_KEY
   settings:
+    user: ENV/NANO_BOTS_END_USER
     model: gpt-3.5-turbo
-    credentials:
-      address: ENV/OPENAI_API_ADDRESS
-      access-token: ENV/OPENAI_API_ACCESS_TOKEN
-      user-identifier: ENV/OPENAI_API_USER_IDENTIFIER

data/static/cartridges/default.yml

@@ -8,7 +8,6 @@ interfaces:
     prompt:
       - text: '🤖'
       - text: '> '
-        color: blue
   eval:
     output:
       stream: true

data/static/fennel/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2016-2022 Calvin Rose and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/static/gem.rb

@@ -3,7 +3,7 @@
 module NanoBot
   GEM = {
     name: 'nano-bots',
-    version: '0.0.9',
+    version: '0.1.0',
     author: 'icebaker',
     summary: 'Ruby Implementation of Nano Bots: small, AI-powered bots',
     description: 'Ruby Implementation of Nano Bots: small, AI-powered bots easily shared as a single file, designed to support multiple providers such as Vicuna, OpenAI ChatGPT, Google PaLM, Alpaca, and LLaMA.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nano-bots
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - icebaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-27 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: babosa
@@ -98,6 +98,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +164,7 @@ files:
 - README.md
 - bin/nb
 - components/adapter.rb
+- components/crypto.rb
 - components/provider.rb
 - components/providers/base.rb
 - components/providers/openai.rb
@@ -154,6 +175,7 @@ files:
 - controllers/interfaces/cli.rb
 - controllers/interfaces/eval.rb
 - controllers/interfaces/repl.rb
+- controllers/security.rb
 - controllers/session.rb
 - docker-compose.example.yml
 - logic/cartridge/adapters.rb
@@ -167,6 +189,7 @@ files:
 - ports/dsl/nano-bots/cli.rb
 - static/cartridges/baseline.yml
 - static/cartridges/default.yml
+- static/fennel/LICENSE
 - static/fennel/fennel.lua
 - static/gem.rb
 homepage: https://github.com/icebaker/ruby-nano-bots