sqrl-core 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1146c068eb45ee56e853601aab7d2cc529814e6667254579a9133d3a44977a63
-  data.tar.gz: 87ec42fb26124ec1d0d23fc6d11f74d4dc434c22f17dafc0ef803053555cba22
+  metadata.gz: 4349344a78214a7b364887b59f9668ff67a7e6aa03961dfe6e3400ad3f75c454
+  data.tar.gz: 077a363c8000cfae1e4e2214bedd7e067515458184fc536ea4fc6854969ffd95
 SHA512:
-  metadata.gz: 4fd9a937c4b7c134ca7c85900dd46184c9275bca550744b942864beacb4c486a704c99e18fb05e67096dca828aa205be1c8d52af077c112a5b128e80eb79aa28
-  data.tar.gz: 5a7477a6d9a87ab52987087c7afb009a21037928b446171a6e8353837be995f6a8c318020c7c48234ddbdd579e8bec6f42b960a65cebc3396ad238105d1073fa
+  metadata.gz: 5764d722e2431303a71c1c3c82e07b9944452be5730e56ef2d87c12181afdd3fafee126ffde881d80fb845c2b1033ba4bc064cbc996c5fd4ff24eb7ac2913da0
+  data.tar.gz: 8ed7f323f1c4ac4d859bf65658deb79c70e961a0796a637169c91b90a6d4ebcbd1368b9305b8a3fb43ecec210310fd84dafd23ff81ca65a0af5fd3bbc09cd4ce

data/CHANGELOG.md

@@ -1,16 +1,65 @@
 # Changelog
 
-## 0.1.1 — 2026-10-20
+All notable changes to `sqrl-core` are documented in this file.
 
-- Fixed: Ed25519 and X25519 keys are built from their DER encodings when the openssl gem
-  has no `OpenSSL::PKey.new_raw_private_key` / `new_raw_public_key` (openssl 3.0 and 3.1,
-  bundled with Ruby 3.1 and 3.2). 0.1.0 raised `NoMethodError` on those Rubies as soon as
-  an identity was derived, signed or verified.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every gem in
+the family shares one version number and is released in lockstep.
 
-## 0.1.0 — 2026-10-20
+## [Unreleased]
+
+## [0.1.2] - 2026-10-21
+
+The server side now follows Steve Gibson's final specification (*SQRL On The Wire* v1.07,
+December 2019) and his latest rulings in the `grc.sqrl` newsgroup (cited as
+`grc.sqrl:<article>`); see `docs/protocol.md`.
+
+### Changed
+
+- The server returns `suk=` in the reply to every command when the client sends `opt=suk`,
+  and always for a disabled account or a previous-identity match. It used to be returned on
+  `query` only (a MUST: grc.sqrl:12289).
+- A successful re-key replies with 0x01 set and 0x02 clear (the post-update state) and
+  clears a disabled state along with the key update (grc.sqrl:20273; On The Wire p. 17).
+- `disable` in CPS mode returns `url=` like every other non-query command.
+- `sqrlonly` / `hardlock` are copied from every successful non-query command (`ident`,
+  `enable`, `disable`), not from `ident` alone.
+- A superseded identity is refused with exactly `0x240`.
+- An unknown, expired or reused nut draws a transient error whose fresh nut is not
+  registered, so the retry fails identically, which is the client's cue to have the user
+  refresh the page (grc.sqrl:23543). Previously the retry "succeeded" against an anonymous
+  pending login that no browser could ever complete.
+- `PendingLogin#cps?` is new.
+
+### Fixed
+
+- Binary `sqrldata` files whose final byte happened to be an ASCII whitespace character
+  (one in about forty, since the last block ends with a random AES-GCM tag) lost that byte on
+  parse and failed with "block ... claims N bytes but only N-1 remain". Only leading
+  whitespace is skipped before the header now; the `SQRLDATA` text form is still trimmed.
+
+### Security
+
+- `Handler#status` reports `authenticated: false` for a login the client completed in CPS
+  mode, so a polling page can no longer be signed in on the strength of a same-device
+  login: the specification requires that only the browser holding the one-time `url=`
+  token is signed in.
+
+## [0.1.1] - 2026-10-20
+
+### Fixed
+
+- Ed25519 and X25519 keys are built from their DER encodings when the openssl gem has no
+  `OpenSSL::PKey.new_raw_private_key` / `new_raw_public_key` (openssl 3.0 and 3.1, bundled
+  with Ruby 3.1 and 3.2). 0.1.0 raised `NoMethodError` on those Rubies as soon as an
+  identity was derived, signed or verified.
+
+## [0.1.0] - 2026-10-20
 
 First release.
 
+### Added
+
 - Complete SQRL wire protocol: `query`, `ident`, `disable`, `enable`, `remove`, every TIF
   bit, `ask`/`btn` with a server-side accept-list, `sin`/`ins`/`pins`, previous identities
   and re-keying, `x=` path extension, Alt-IDs, `can=`, Client Provided Session.
@@ -26,3 +75,8 @@ First release.
   `before_handle` hooks and `SQRL::Server::RateLimited`.
 - A shared store-contract spec for store implementations.
 - Requires Ruby 3.1 or newer.
+
+[Unreleased]: https://github.com/danielpclark/sqrl-ruby/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/danielpclark/sqrl-ruby/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/danielpclark/sqrl-ruby/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/danielpclark/sqrl-ruby/releases/tag/v0.1.0

data/lib/sqrl/server/stores.rb

@@ -62,6 +62,12 @@ module SQRL
       def authenticated? = !authenticated_idk.nil?
       def asked? = asked ? true : false
 
+      # Whether the SQRL client completed this login in CPS mode (a one-time +url=+ token was
+      # issued). Such a login may only be completed by the browser that presents that token,
+      # never through the poll. The token field stays set until the token is claimed, so an
+      # unclaimed or expired token keeps the poll closed, as the specification requires.
+      def cps? = !cps_token.nil?
+
       def expired?(now)
         !expires_at.nil? && expires_at <= now
       end

data/lib/sqrl/server.rb

@@ -95,6 +95,10 @@ module SQRL
       def status(pending_login_id)
         login = pending_login_id && @stores.pending_logins.find(pending_login_id)
         return { authenticated: false, idk: nil } if login.nil? || login.expired?(@config.now)
+        # A login the client flagged cps is completed only through the url= token the client
+        # hands its own browser: "the web server ... MUST NOT authenticate the browser session
+        # upon successful authentication" (On The Wire v1.07 p.14; Operating Details p.4).
+        return { authenticated: false, idk: nil } if login.cps?
 
         { authenticated: login.authenticated?,
           idk: login.authenticated_idk && Util.b64u_encode(login.authenticated_idk) }
@@ -256,7 +260,11 @@ module SQRL
             return fail_with(Tif::COMMAND_FAILED)
           end
 
-          return fail_with(Tif::IDENTITY_SUPERSEDED | Tif::COMMAND_FAILED) if @stores.identities.superseded?(idk)
+          if @stores.identities.superseded?(idk)
+            # "the server must immediately fail that client query by returning a TIF of 0x240"
+            @tif = 0
+            return fail_with(Tif::IDENTITY_SUPERSEDED | Tif::COMMAND_FAILED)
+          end
 
           # --- which identity does the server know? ---
           current = @stores.identities.find(idk)
@@ -291,22 +299,24 @@ module SQRL
             ins_ok = @sin.nil? || previous.ins.nil? || Util.secure_compare(previous.ins, cget.call("pins").to_s)
             if suk_new && vuk_new && urs_ok.call(previous.vuk) && ins_ok
               current = @stores.identities.rekey(pidk, idk, suk: suk_new, vuk: vuk_new, ins: cget.call("ins"))
+              # The urs under the previous identity's VUK carries the same (rescue code) authority
+              # as an enable, so a disabled account comes back enabled under its new key, "so that
+              # the account can be immediately used under the new key" (Gibson, grc.sqrl:20273).
+              current = @stores.identities.update(idk, disabled: false) if current.disabled?
               @result.rekeyed_from = pidk
               @result.identity = current
-              matched = current
               id_match = true
+              # TIF bits describe the account AFTER the update: current-ID match on, previous-ID
+              # match off (On The Wire v1.07 p.16-17; Gibson, grc.sqrl:22934).
               @tif |= Tif::ID_MATCH
+              @tif &= ~(Tif::PREVIOUS_ID_MATCH | Tif::SQRL_DISABLED)
             else
               rekey_failed = true
             end
           end
 
-          suk_to_return = nil
           case cmd
           when Command::QUERY
-            if matched && (opts.suk? || matched.disabled? || prev_match)
-              suk_to_return = matched.suk
-            end
             # An ask is only valid in a query reply that recognises the current identity.
             if ask_pending && id_match
               @extra << ["ask", ask.to_wire]
@@ -340,16 +350,21 @@ module SQRL
             if rekey_failed || !id_match
               @tif |= Tif::COMMAND_FAILED
             else
-              current = @stores.identities.update(idk, disabled: true)
+              current = @stores.identities.update(idk, disabled: true, sqrlonly: opts.sqrlonly?,
+                                                       hardlock: opts.hardlock?)
               @result.identity = current
               @tif |= Tif::SQRL_DISABLED
+              # "url= must be provided by the server in its response to any command, other than
+              # query, when the SQRL client includes opt=cps" (On The Wire v1.07 p.14).
+              issue_cps_url if opts.cps?
             end
           when Command::ENABLE
             if rekey_failed || !id_match || ask_refused
               @tif |= Tif::COMMAND_FAILED
             elsif prev_match || urs_ok.call(current.vuk)
               # after a re-key the urs was already verified against the old vuk
-              current = @stores.identities.update(idk, disabled: false, logins: current.logins.to_i + 1)
+              current = @stores.identities.update(idk, disabled: false, logins: current.logins.to_i + 1,
+                                                       sqrlonly: opts.sqrlonly?, hardlock: opts.hardlock?)
               @tif &= ~Tif::SQRL_DISABLED
               authenticate!(current, cmd, opts)
             else
@@ -369,7 +384,14 @@ module SQRL
             end
           end
 
-          @extra << ["suk", Util.b64u_encode(suk_to_return)] if suk_to_return
+          # The stored SUK goes back whenever the client asked for it with opt=suk (a MUST:
+          # Gibson, grc.sqrl:12289, 9 Jan 2016) and whenever the client is likely to need it for
+          # a urs: the account is disabled, or it was recognised by a previous identity
+          # (On The Wire v1.07 p.14). It accompanies every command's reply, as GRC's server does.
+          identity_now = @result.identity
+          if identity_now && (opts.suk? || identity_now.disabled? || prev_match)
+            @extra << ["suk", Util.b64u_encode(identity_now.suk)]
+          end
           respond
         end
 
@@ -441,17 +463,19 @@ module SQRL
           @extra << ["url", url]
         end
 
-        # Unknown or reused nut: transient error, hand out a fresh nut bound to a new
-        # anonymous pending login so the client can retry.
+        # Unknown, expired or reused nut: transient error. This server keeps its state "by
+        # reference" (On The Wire, "Transient Error Details", second case), so the browser
+        # session behind a stale nut cannot be recovered. The reply carries a fresh nut, as every
+        # reply must, but that nut is deliberately not registered: the client's retry fails with
+        # the identical TIF, which is the client's cue to tell its user to refresh the login page
+        # (Gibson, grc.sqrl:23543, 23 Nov 2019; On The Wire v1.07 p.17).
         def transient_error
           @tif |= Tif::TRANSIENT_ERROR | Tif::COMMAND_FAILED
-          @login_id = @handler.new_id
-          @login = @stores.pending_logins.create(@login_id, ip: @ip, return_to: nil,
-                                                            expires_at: @now + @config.nut_ttl, created_at: @now)
-          @result.pending_login_id = @login_id
+          @login_id = nil
+          @login = nil
           @bound = nil
           @sin = @config.sin_for(context)
-          respond
+          respond(register_nut: false)
         end
 
         def fail_with(bits)
@@ -459,14 +483,16 @@ module SQRL
           respond
         end
 
-        def respond
+        def respond(register_nut: true)
           nut = @handler.new_nut
           text = "ver=#{Protocol::VERSION}\r\nnut=#{nut}\r\ntif=#{Tif.new(@tif).to_hex}\r\nqry=#{@config.path}?nut=#{nut}\r\n"
           text << "sin=#{@sin}\r\n" if @sin
           @extra.each { |k, v| text << "#{k}=#{v}\r\n" }
           body = Util.b64u_encode(text.b)
-          @stores.nuts.issue(nut: nut, pending_login_id: @login_id, expected_server: body,
-                             ip: @record ? @record.ip : @ip, bound_idk: @bound, expires_at: @now + @config.nut_ttl)
+          if register_nut
+            @stores.nuts.issue(nut: nut, pending_login_id: @login_id, expected_server: body,
+                               ip: @record ? @record.ip : @ip, bound_idk: @bound, expires_at: @now + @config.nut_ttl)
+          end
           @result.body = body
           @result.tif = Tif.new(@tif)
           @result.pending_login = @login

data/lib/sqrl/storage.rb

@@ -407,17 +407,20 @@ module SQRL
 
     # Parse either the binary (+sqrldata+) or the textual base64url (+SQRLDATA+) form.
     def self.parse(input)
-      trimmed = Storage.trim_ascii(input)
-      raise FormatError, "identity data too short" if trimmed.bytesize < 8
+      # Only leading whitespace is skipped before the header is read: the binary form ends
+      # with an AES-GCM tag whose last byte may itself be a whitespace character, so trimming
+      # the tail would truncate roughly one file in forty.
+      data = input.b.sub(/\A[ \t\r\n\f\v]+/, "")
+      raise FormatError, "identity data too short" if data.bytesize < 8
 
-      header = trimmed.byteslice(0, 8)
+      header = data.byteslice(0, 8)
       if header == HEADER_TEXT
-        text = trimmed.byteslice(8..)
+        text = Storage.trim_ascii(data.byteslice(8..))
         raise FormatError, "invalid SQRLDATA text" unless text.force_encoding("UTF-8").valid_encoding?
 
         return parse_blocks(Util.b64u_decode(text))
       end
-      return parse_blocks(trimmed.byteslice(8..)) if header == HEADER_BINARY
+      return parse_blocks(data.byteslice(8..)) if header == HEADER_BINARY
 
       raise FormatError, "missing sqrldata header"
     end

data/lib/sqrl/version.rb

@@ -2,5 +2,5 @@
 
 module SQRL
   # Version shared by every gem in the family.
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqrl-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel P. Clark