glazed-oxidized 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f2ea93455706c7b24047955aa5568d5e54275437ba028dfedea25975a06d8cc
+  data.tar.gz: 2c16dd38d731d7c326b1fe52f11eb280d1e08f6dcb39304321e473371d9d88cb
+SHA512:
+  metadata.gz: 29c083a2ab28aa4413476bed9b18a2982663aa51083c55db244f0e6440459f63f9d65cde4e82ef8b409947148bf135fd6b9b2a84722a7342b2c4c1595a0f571b
+  data.tar.gz: 387474290b6096c7d4df7dc24ecff6256c74024a9c10665a73f0c02272ce5322eaa7d77aac817b3fc497e22f22df32f49eab56350c4cc671f391f6cfc24c90f6

data/.yardopts

@@ -0,0 +1,5 @@
+--load ../support/yard/rbs_inline.rb
+--private
+--protected
+--exclude lib/glazed/v1/
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [0.1.0] - 2026-10-14
+
+- Run Oxidized model files as `oxidized_<model>` dialects, each loaded into its own Ruby::Box.
+- Turn the substitutions in models' `cmd :secret` blocks into sensitive patterns for the `redact` step.
+
+## [0.1.0] - 2025-03-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,16 @@
+# glazed-oxidized
+
+Runs [Oxidized](https://github.com/ytti/oxidized) model files as [glazed](https://github.com/sorah/glazed) dialects. A node whose dialect is `oxidized_<model>` runs the model file `<model>.rb`, such as `oxidized_eos` for `eos.rb`. Each model file is loaded into its own [Ruby::Box](https://docs.ruby-lang.org/en/4.0/Ruby/Box.html), so whatever it defines at the top level, patches into core classes or sets as globals stays out of glazed.
+
+Requires Ruby 4.0 or later, started with `RUBY_BOX=1`, and Oxidized model files from the `oxidized` gem or a directory.
+
+```jsonc
+// glazed.json
+{"requires": ["glazed/oxidized"], ...}
+```
+
+```
+RUBY_BOX=1 bundle exec glazed run -c glazed.json
+```
+
+The substitutions in a model's `cmd :secret` blocks become the dialect's sensitive patterns, so the `redact` step hides the secrets the model knows about. See [docs/oxidized-shim.md](../docs/oxidized-shim.md) for usage, node variables, secrets and limitations.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Bundler::GemHelper.tag_prefix = "glazed-oxidized/"
+
+task default: :spec

data/lib/glazed/oxidized/bridge.rb

@@ -0,0 +1,148 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed/cli_session'
+require 'glazed/dialect/run'
+require 'glazed/oxidized/errors'
+require 'glazed/oxidized/model_box'
+require 'glazed/oxidized/node_view'
+
+module Glazed
+  module Oxidized
+    # Connects one CLI session to an instance of an Oxidized model, so that the
+    # model and its inputs reach the device through glazed.
+    #
+    # A bridge is created on first use for a session, which may be an
+    # interaction during login, and is attached to the run after login.
+    class Bridge
+      @registry = ObjectSpace::WeakKeyMap.new #: ObjectSpace::WeakKeyMap
+      @registry_lock = Mutex.new #: Thread::Mutex
+
+      # Finds or creates the bridge of a session.
+      #
+      # @param session [CliSession] session to the device
+      # @param box [ModelBox] model the session runs
+      # @return [Bridge] the session's bridge
+      #: (CliSession session, ModelBox box) -> Bridge
+      def self.for(session, box)
+        @registry_lock.synchronize { @registry[session] ||= new(session:, box:) }
+      end
+
+      # @param session [CliSession] session to the device
+      # @param box [ModelBox] model the session runs
+      #: (session: CliSession, box: ModelBox) -> void
+      def initialize(session:, box:)
+        @session = session #: CliSession
+        @run = nil #: Dialect::Run?
+        @model = box.new_model #: untyped
+        @model.input = box.new_generic_input.glazed_attach(self, nil)
+      end
+
+      # @return [CliSession] session to the device
+      #: CliSession
+      attr_reader :session
+      # @return [Object] the model instance
+      #: untyped
+      attr_reader :model
+
+      # Binds the model and the input configured for the transport to a run.
+      #
+      # @param run [Dialect::Run] the run in progress
+      # @param input [Object] the box's input, with the model's cfg blocks evaluated
+      # @return [void]
+      #: (Dialect::Run run, untyped input) -> void
+      def attach(run, input)
+        @run = run
+        node = NodeView.new(node: run.node, prompt: session.prompt)
+        input.glazed_attach(self, node)
+        model.node = node
+        model.input = input
+      end
+
+      # Collects the configuration through the model.
+      #
+      # @return [String] the configuration
+      # @raise [Error] when a command of the model returned no output
+      #: () -> String
+      def get
+        model.glazed_get or raise Error, 'the Oxidized model returned no configuration'
+      end
+
+      # Applies one of the model's expect blocks to the session buffer.
+      #
+      # @param index [Integer] position of the block among the model's expects
+      # @param buffer [String] copy of the session buffer
+      # @return [String] the new buffer, as bytes
+      #: (Integer index, String buffer) -> String
+      def apply_expect(index, buffer) = model.glazed_expect(index, buffer).to_s.b
+
+      # Sends raw data.
+      #
+      # @param data [String] data to send
+      # @return [void]
+      #: (String data) -> void
+      def write(data)
+        session.write(data)
+      end
+
+      # @return [String] data received but not consumed yet
+      #: () -> String
+      def output = session.buffer.dup
+
+      # Waits for one of the patterns, consuming the buffer up to the match.
+      #
+      # @param patterns [Array<Regexp>] patterns
+      # @return [Regexp] the pattern that matched
+      # @raise [TimeoutError] when nothing matches in time
+      #: (Array[Regexp] patterns) -> Regexp
+      def expect(patterns)
+        cli = session #: as untyped
+        cli.expect(*patterns).regexp
+      end
+
+      # Runs a command the way Oxidized inputs do: on a shell, the output
+      # includes the echoed command and the prompt, which models cut.
+      #
+      # @param line [String] command line
+      # @param expect [Regexp, Array<Regexp>, nil] patterns ending the output; nil only sends the line
+      # @param exec [Boolean] run on an exec channel when the transport supports it
+      # @return [String] the output, in UTF-8
+      # @raise [TimeoutError] when nothing matches in time
+      # @raise [InvalidEncoding] when the output is not valid UTF-8
+      #: (String line, Regexp | Array[Regexp] | nil expect, exec: bool) -> String
+      def cmd(line, expect, exec:)
+        unless expect
+          write("#{line}\n")
+          return +''
+        end
+
+        transport = session.transport
+        raw = if exec && transport.exec?
+          transport.exec(line, timeout: session.timeout).b
+        else
+          cli = session #: as untyped
+          cli.discard
+          write("#{line}\n")
+          match = cli.expect(*Array(expect)) #: MatchData
+          match.pre_match + match[0].to_s
+        end
+        normalize(line, raw)
+      end
+
+      # @param line [String] command line
+      # @param raw [String] output as bytes
+      # @return [String] the output after the dialect's output filters, in UTF-8
+      # @raise [InvalidEncoding] when the output is not valid UTF-8
+      #: (String line, String raw) -> String
+      private def normalize(line, raw)
+        filters = @run&.dialect&.output_filters || []
+        output = filters.inject(raw) { |text, output_filter| output_filter.call(text) }.dup.force_encoding(Encoding::UTF_8)
+        raise InvalidEncoding, "output of #{line.inspect} is not valid UTF-8" unless output.valid_encoding?
+
+        output
+      end
+    end
+  end
+end

data/lib/glazed/oxidized/errors.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed'
+
+module Glazed
+  module Oxidized
+    # Base class for errors raised by glazed-oxidized.
+    class Error < Glazed::Error; end
+    # Raised when Ruby::Box is unavailable.
+    class UnavailableError < Error; end
+    # Raised when a model file defines no model class by its name.
+    class ModelNotFound < Error; end
+    # Raised when a model has no cfg block for the transport of a node.
+    class UnsupportedTransport < Error; end
+    # Raised when a model's `cmd :secret` blocks cannot be turned into sensitive patterns.
+    class UnredactableModel < Error; end
+  end
+end

data/lib/glazed/oxidized/model_box.rb

@@ -0,0 +1,115 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed/must'
+require 'glazed/oxidized/errors'
+require 'glazed/oxidized/secret_substitution'
+
+module Glazed
+  module Oxidized
+    # An Oxidized model file loaded into its own Ruby::Box, together with the
+    # emulated Oxidized API it builds on, so that its top-level classes,
+    # monkey patches and globals stay out of the main box.
+    #
+    # @example
+    #   box = Glazed::Oxidized::ModelBox.new(name: 'ios', path: '/path/to/model/ios.rb')
+    #   box.model_class.prompt #=> /^([\w.@()-]+#\s?)$/
+    class ModelBox
+      # File loaded into each box before the model.
+      PRELUDE = File.expand_path('prelude.rb', __dir__) #: String
+
+      # Input class names inside the box, by glazed transport name.
+      INPUTS = {ssh: :SSH, telnet: :Telnet}.freeze #: Hash[Symbol, Symbol]
+
+      # @param name [String] model name, the file name without extension
+      # @param path [String] path of the model file
+      # @raise [ModelNotFound] when the file defines no model class by that name
+      # @raise [UnavailableError] when Ruby::Box is not enabled
+      #: (name: String, path: String) -> void
+      def initialize(name:, path:)
+        ModelBox.ensure_enabled!
+        @name = name #: String
+        @path = path #: String
+        @box = Ruby::Box.new #: Ruby::Box[top]
+        @box.require(PRELUDE)
+        @box.require(path)
+        @model_class = find_model_class #: untyped
+      end
+
+      # @return [String] model name
+      #: String
+      attr_reader :name
+      # @return [String] path of the model file
+      #: String
+      attr_reader :path
+      # @return [Class] the model class, a subclass of the box's Oxidized::Model
+      #: untyped
+      attr_reader :model_class
+
+      # @raise [UnavailableError] when Ruby::Box is not enabled
+      # @return [void]
+      #: () -> void
+      def self.ensure_enabled!
+        return if defined?(Ruby::Box) && Ruby::Box.enabled?
+
+        raise UnavailableError, 'glazed-oxidized loads models into Ruby::Box; run Ruby 4.0+ with RUBY_BOX=1'
+      end
+
+      # @return [Object] a new instance of the model
+      #: () -> untyped
+      def new_model = model_class.new
+
+      # @return [Array<SecretSubstitution>] substitutions of the model's `cmd :secret` blocks, in order
+      # @raise [UnredactableModel] when a block does anything but substitute strings for patterns
+      #: () -> Array[SecretSubstitution]
+      def secret_substitutions
+        recorder = oxidized.const_get(:SecretRecorder)
+        begin
+          recorder.record(model_class).map { |pattern, replacement| SecretSubstitution.new(pattern:, replacement:) }
+        rescue recorder.const_get(:Unrecordable) => e
+          raise UnredactableModel, "cmd :secret blocks of Oxidized model #{name} #{e.message}"
+        end
+      end
+
+      # @return [Object] a new instance of the box's Oxidized::Input
+      #: () -> untyped
+      def new_generic_input = oxidized.const_get(:Input).new
+
+      # Builds an input with the model's cfg blocks for a transport evaluated on it.
+      #
+      # @param kind [Symbol] glazed transport name
+      # @return [Object, nil] the input, or nil when the model has no cfg block for the transport
+      #: (Symbol kind) -> untyped
+      def configured_input(kind)
+        class_name = INPUTS[kind] or return nil
+        blocks = model_class.cfgs.fetch(kind.to_s, [])
+        return nil if blocks.empty?
+
+        input = oxidized.const_get(class_name).new
+        blocks.each { input.instance_exec(&it) }
+        input
+      end
+
+      # @return [Module] the box's Oxidized module
+      #: () -> Module[untyped]
+      private def oxidized = Must.be_a(@box.const_get(:Oxidized), Module)
+
+      # Finds the class named after the file, ignoring case, as Oxidized does.
+      #
+      # @return [Class] the model class
+      # @raise [ModelNotFound] when there is none
+      #: () -> untyped
+      private def find_model_class
+        constant = @box.constants.find { it.to_s.casecmp?(name) }
+        klass = constant && @box.const_get(constant)
+        unless klass.is_a?(Class) && klass < oxidized.const_get(:Model)
+          raise ModelNotFound, "#{path} defines no Oxidized model named #{name}"
+        end
+
+        klass
+      end
+    end
+  end
+end

data/lib/glazed/oxidized/model_dialect.rb

@@ -0,0 +1,119 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed/dialects/base'
+require 'glazed/oxidized/errors'
+require 'glazed/oxidized/bridge'
+require 'glazed/oxidized/model_box'
+
+module Glazed
+  module Oxidized
+    # Base class of dialects that run an Oxidized model.
+    #
+    # The model's prompt, comment prefix, expect blocks and login prompts map
+    # to dialect declarations. Commands, pre and post blocks, and cfg blocks
+    # run inside the model's box, as one :get runbook step. The substitutions
+    # of the model's `cmd :secret` blocks become sensitive patterns, and the
+    # blocks themselves run when the node param "remove_secret" is "true".
+    class ModelDialect < Dialects::Base
+      # Prompt Oxidized uses for models that declare none.
+      DEFAULT_PROMPT = /^([\w.@-]+[#>]\s?)$/ #: Regexp
+
+      @model_box = nil #: ModelBox?
+      @unredactable = nil #: String?
+
+      class << self
+        # Builds a dialect class for a loaded model.
+        #
+        # @param box [ModelBox] the loaded model
+        # @return [Class<ModelDialect>] the dialect
+        # @example
+        #   Glazed::Oxidized::ModelDialect.build(Glazed::Oxidized::ModelBox.new(name: 'ios', path:))
+        #: (ModelBox box) -> singleton(ModelDialect)
+        def build(box)
+          dialect = Class.new(self)
+          dialect.declare(box)
+          dialect
+        end
+
+        # @return [ModelBox] the model this dialect runs
+        # @raise [Must::Violation] on {ModelDialect} itself
+        #: () -> ModelBox
+        def model_box = Must.expect(@model_box)
+
+        # @return [Array<Glazed::Dialect::SensitivePattern>] patterns from the model's `cmd :secret` blocks
+        # @raise [UnredactableModel] when the blocks cannot be turned into patterns
+        #: () -> Array[Glazed::Dialect::SensitivePattern]
+        def sensitive_patterns
+          reason = @unredactable
+          raise UnredactableModel, reason if reason
+
+          super
+        end
+
+        # @param box [ModelBox] the model to run
+        # @return [void]
+        #: (ModelBox box) -> void
+        protected def declare(box)
+          @model_box = box
+          model = box.model_class
+          prompt(model.prompt || DEFAULT_PROMPT)
+          comment_prefix(model.comment)
+          model.expects.each_with_index do |(pattern, _block), index|
+            interact(pattern) do |cli, buffer, _match|
+              Glazed::Dialect::Actions::Replace.new(content: Bridge.for(cli, box).apply_expect(index, buffer))
+            end
+          end
+          declare_secrets(box)
+          ModelBox::INPUTS.each_key do |kind|
+            communication(kind) { |config| configure(config, kind) }
+          end
+          runbook(:get) do |book|
+            book.raw("oxidized model #{box.name}") { |run| run.emit(Bridge.for(run.cli, box).get) }
+          end
+        end
+
+        # Declares a sensitive pattern for each substitution of the model's
+        # `cmd :secret` blocks. Blocks that do anything else make
+        # {sensitive_patterns} raise, so redaction fails rather than leaks.
+        #
+        # @param box [ModelBox] the loaded model
+        # @return [void]
+        #: (ModelBox box) -> void
+        private def declare_secrets(box)
+          box.secret_substitutions.each do |substitution|
+            sensitive_pattern(substitution.pattern) { substitution.offsets(it) }
+          end
+        rescue UnredactableModel => e
+          @unredactable = e.message
+        end
+
+        # Applies the model's cfg blocks for a transport to a communication config.
+        #
+        # @param config [Glazed::Dialect::CommunicationConfig] config to fill
+        # @param kind [Symbol] transport name
+        # @return [void]
+        #: (Glazed::Dialect::CommunicationConfig config, Symbol kind) -> void
+        private def configure(config, kind)
+          box = model_box
+          input = box.configured_input(kind)
+          unless input
+            config.post_login { raise UnsupportedTransport, "Oxidized model #{box.name} has no cfg block for #{kind}" }
+            return
+          end
+
+          config.username_prompt = input.glazed_username_prompt
+          config.password_prompt = input.glazed_password_prompt
+          config.exec = input.glazed_exec?
+          config.post_login do |run|
+            Bridge.for(run.cli, box).attach(run, input)
+            input.connect_cli
+          end
+          config.pre_logout { input.disconnect_cli }
+        end
+      end
+    end
+  end
+end