safire 0.1.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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,159 @@
+# Safire
+
+[![Gem Version](https://badge.fury.io/rb/safire.svg)](https://badge.fury.io/rb/safire)
+[![CI](https://github.com/vanessuniq/safire/workflows/CI/badge.svg)](https://github.com/vanessuniq/safire/actions)
+[![Coverage](https://codecov.io/gh/vanessuniq/safire/branch/main/graph/badge.svg)](https://codecov.io/gh/vanessuniq/safire)
+[![Documentation](https://img.shields.io/badge/docs-yard-blue.svg)](https://vanessuniq.github.io/safire)
+
+Safire is a lean Ruby library that implements [SMART on FHIR](https://hl7.org/fhir/smart-app-launch/) and [UDAP](https://hl7.org/fhir/us/udap-security/) client protocols for healthcare applications.
+
+---
+
+## Features
+
+### SMART on FHIR App Launch (v2.2.0)
+
+- Discovery (`/.well-known/smart-configuration`)
+- Public Client (PKCE)
+- Confidential Symmetric Client (`client_secret` + HTTP Basic Auth)
+- Confidential Asymmetric Client (`private_key_jwt` with RS384/ES384)
+- POST-Based Authorization
+
+### UDAP
+
+> Planned. See [ROADMAP.md](https://github.com/vanessuniq/safire/blob/main/ROADMAP.md) for details.
+
+---
+
+## Installation
+
+Requires Ruby ≥ 4.0.2.
+
+```ruby
+gem 'safire'
+```
+
+```bash
+bundle install
+```
+
+---
+
+## Quick Start
+
+```ruby
+require 'safire'
+
+# Step 1 — Create a client (Hash config or Safire::ClientConfig.new)
+client = Safire::Client.new(
+  base_url:     'https://launch.smarthealthit.org/v/r4/sim/eyJoIjoiMSJ9/fhir',
+  client_id:    'my_client_id',
+  redirect_uri: 'https://myapp.example.com/callback',
+  scopes:       ['openid', 'profile', 'patient/*.read']
+)
+
+# Step 2 — Discover SMART metadata (lazy — only called when needed)
+metadata = client.server_metadata
+puts metadata.authorization_endpoint
+puts metadata.capabilities.join(', ')
+
+# Step 3 — Build the authorization URL (Safire generates state + PKCE automatically)
+auth_data = client.authorization_url
+# auth_data => { auth_url:, state:, code_verifier: }
+# Store state and code_verifier server-side, redirect the user to auth_data[:auth_url]
+
+# Step 4 — Exchange the authorization code for tokens (on callback)
+token_data = client.request_access_token(
+  code:          params[:code],
+  code_verifier: session[:code_verifier]
+)
+# token_data => { "access_token" => "...", "token_type" => "Bearer", ... }
+
+# Step 5 — Refresh when the access token expires
+new_tokens = client.refresh_token(refresh_token: token_data['refresh_token'])
+```
+
+### Supported SMART Client Types
+
+| `client_type:` | Authentication | When to use |
+|----------------|----------------|-------------|
+| `:public` (default) | PKCE only | Browser/mobile apps that cannot store a secret |
+| `:confidential_symmetric` | HTTP Basic Auth (`client_secret`) | Server-side apps with a securely stored secret |
+| `:confidential_asymmetric` | JWT assertion (`private_key_jwt`, RS384/ES384) | Server-side apps using a registered key pair |
+
+For a confidential asymmetric client, provide a private key and key ID:
+
+```ruby
+client = Safire::Client.new(
+  {
+    base_url:    'https://fhir.example.com',
+    client_id:   'my_client_id',
+    redirect_uri: 'https://myapp.example.com/callback',
+    scopes:      ['openid', 'profile', 'patient/*.read'],
+    private_key: OpenSSL::PKey::RSA.new(File.read('private_key.pem')),
+    kid:         'my-key-id-123'
+  },
+  client_type: :confidential_asymmetric
+)
+# Authorization and token exchange are identical — Safire builds the JWT assertion automatically
+```
+
+---
+
+## Configuration
+
+```ruby
+Safire.configure do |config|
+  config.logger   = Rails.logger   # Default: $stdout
+  config.log_http = true           # Log HTTP requests (sensitive headers always filtered)
+end
+```
+
+See the [Configuration Guide](https://vanessuniq.github.io/safire/configuration/) for all options including `user_agent`, `log_level`, and SSL settings.
+
+---
+
+## Demo Application
+
+A Sinatra-based demo is included in [`examples/sinatra_app/`](examples/sinatra_app/):
+
+```bash
+bin/demo
+# Visit http://localhost:4567
+```
+
+Demonstrates SMART discovery, all authorization flows, and token refresh. See [`examples/sinatra_app/README.md`](examples/sinatra_app/README.md) for details.
+
+---
+
+## Development
+
+```bash
+bin/setup            # Install dependencies
+bundle exec rspec    # Run tests
+bin/console          # Interactive prompt
+```
+
+To serve the docs locally:
+
+```bash
+bin/docs
+cd docs && bundle install && bundle exec jekyll serve
+# Visit http://localhost:4000/safire/
+```
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please read [CONTRIBUTION.md](https://github.com/vanessuniq/safire/blob/main/CONTRIBUTION.md) before opening a PR — it covers branch naming, commit message style, and the sign-off requirement.
+
+---
+
+## License
+
+Available as open source under the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
+
+---
+
+*Parts of this project were developed with AI assistance (Claude Code) and reviewed by maintainers.*

data/ROADMAP.md

@@ -0,0 +1,54 @@
+# Safire Roadmap
+
+## Current Release — v0.0.1
+
+Safire is in early development (pre-release). The API is functional but not yet stable — breaking changes may occur before v1.0.0. Published to [RubyGems](https://rubygems.org/gems/safire).
+
+Feedback, bug reports, and pull requests are welcome via the [issue tracker](https://github.com/vanessuniq/safire/issues).
+
+---
+
+## Implemented Features
+
+### SMART on FHIR App Launch (v2.2.0)
+
+- **Discovery** — lazy fetch of `/.well-known/smart-configuration`; metadata cached per client instance
+- **Public Client** — PKCE-only authorization code flow (RS256/ES256)
+- **Confidential Symmetric Client** — client secret + HTTP Basic Auth + PKCE
+- **Confidential Asymmetric Client** — `private_key_jwt` with RS384/ES384; JWKS URI support; auto-detected algorithm from key type
+- **POST-Based Authorization** — form-encoded authorization requests
+- **JWT Assertion Builder** — signed JWT assertions with configurable `kid` and expiry
+- **PKCE** — automatic code verifier and challenge generation
+
+---
+
+## Planned Features
+
+### SMART on FHIR
+
+- **Backend Services** — `client_credentials` grant for system-to-system flows (no user interaction)
+- **Dynamic Client Registration** — programmatic client registration per [RFC 7591](https://www.rfc-editor.org/rfc/rfc7591)
+
+### UDAP Security
+
+- **UDAP Discovery** — `/.well-known/udap` metadata fetch and validation
+- **UDAP Dynamic Client Registration** — signed software statements and client registration
+- **UDAP JWT Client Auth** — B2B and consumer-facing authorization flows
+- **Tiered OAuth** — identity chaining for multi-system access
+
+### Quality and Compliance
+
+- **Inferno SMART App Launch STU2.2 Test Suite** — full passing run against the [Inferno Framework](https://inferno-framework.github.io/)
+
+---
+
+## Compatibility
+
+| Component | Version |
+|-----------|---------|
+| Ruby | ≥ 4.0.2 |
+| ActiveSupport | ~> 8.0 |
+| Rails (optional) | 7.x, 8.x |
+| SMART App Launch | 2.2.0 (STU2) |
+| UDAP Security | 1.0 (planned) |
+| FHIR | R4, R4B |

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop]
+
+desc 'Setup development environment'
+task :setup do
+  sh 'bin/setup'
+  puts 'Development environment ready!'
+end
+
+desc 'Run security audit'
+task :audit do
+  sh 'bundle exec bundler-audit check --update'
+end
+
+desc 'Generate documentation'
+task :docs do
+  sh 'bin/docs'
+end

data/docs/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: page
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/docs/Gemfile

@@ -0,0 +1,37 @@
+source 'https://rubygems.org'
+
+# Jekyll 4.x for Ruby 4.0+ compatibility
+gem 'jekyll', '~> 4.4'
+
+# Use Just-the-Docs theme for clean, searchable documentation
+gem 'just-the-docs'
+
+# Jekyll plugins
+group :jekyll_plugins do
+  gem 'jekyll-feed', '~> 0.17'
+  gem 'jekyll-seo-tag'
+  gem 'jekyll-sitemap'
+end
+
+# Ruby 4.0+ requires explicit declaration of gems removed from stdlib
+gem 'base64'
+gem 'bigdecimal'
+gem 'csv'
+gem 'logger'
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :windows, :jruby do
+  gem 'tzinfo', '>= 1', '< 3'
+  gem 'tzinfo-data'
+end
+
+# Performance-booster for watching directories on Windows
+gem 'wdm', '~> 0.1', platforms: %i[windows]
+
+# Lock `http_parser.rb` gem to `v0.8.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem 'http_parser.rb', '~> 0.8.0', platforms: [:jruby]
+
+# For serving locally
+gem 'webrick'