omniauth-proconnect 0.3.0 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3798432d91f891378bd3a61ac701ed300d262613b961c9d2e7c6ef9e7f72d8bd
-  data.tar.gz: a13a4a55b57569fbb93907b35966aa6855beb6002f73a66088d19dcd0f4a00b9
+  metadata.gz: 22b5aa93fbeaed22dcd94aae481c679e1a7c1643fc55ab44156b5b40d57b45f0
+  data.tar.gz: 90f7a2ba844b68e401c5a6bb033fb3c52434a6d9ea96ac1bdcfb177813480103
 SHA512:
-  metadata.gz: 6bc5467a0edef737742ed477ec0ddb175e45e58298ffde705bb3162a214cc802cf52f98568e5c20ffc98d4a6a2812fab98840a185d0d0ddc9b1e9b37cb464bfe
-  data.tar.gz: d68e03e9eb2e796da1f68d270eb322f52b2e429c1ab0554e78f040bfa768a20c70e09dc89a62d701fd9053cb1f99060e3e16f9c04aa9a15c71e97e7b2bb8c471
+  metadata.gz: f1e34f86a8434d76ea23fa8e838889fd64c3cdffd98a6e9746829549c3ec33482c293b5e38d99f8816cdefaba287359a58273b76bbead12d8ab8f502de3edd5a
+  data.tar.gz: 2d47a040f566c42873756f87087d05d36a4974994c67ff2ef546f6e300b213db87b89f91a4bd6b1eaff788eb6c2f97f8e5359b1ba576976c7bd052d5f9aa3d02

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 3.1
 

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-05-23 15:10:03 UTC using RuboCop version 1.75.4.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 123
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/omniauth/proconnect.rb'

data/README.md

@@ -15,13 +15,18 @@ générique
 [`omniauth_openid_connect`](https://github.com/omniauth/omniauth_openid_connect)
 qui malgré son degré de maturité supérieure semble à l'abandon aussi.
 
+La suite du README décrit brièvement la configuration de la librairie. Si vous
+n'êtes pas encore familier avec OIDC et OmniAuth, un [guide complet de
+configuration d'omniauth-proconnect est aussi disponible sur le
+wiki](https://github.com/betagouv/omniauth-proconnect/wiki/Guide-de-connexion).
+
 ## Utilisation
 
 Une fois que vous avez créé votre application sur [l'espace
 partenaires de
 ProConnect](https://partenaires.proconnect.gouv.fr/apps) et identifié
 vos endpoints grâce à leur [documentation
-technique](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique))
+technique](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique)
 :
 
 1. installer la gem `bundle add omniauth-proconnect` ;
@@ -44,7 +49,11 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-3. envoyez votre utilisateur sur la stratégie :
+**⚠️ NOTE :** [La valeur de `PROCONNECT_DOMAIN` doit finir par
+`/api/v2`](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/implementation_technique#12-valeur-de-proconnect_domain),
+ce n'est pas seulement l'hôte. C.f https://github.com/betagouv/omniauth-proconnect/issues/5
+
+3.  envoyez votre utilisateur sur la stratégie :
 
 ```erb
 <%= button_to "Se connecter via ProConnect", "/auth/proconnect", method: :post, remote: false, data: { turbo: false } %>
@@ -59,6 +68,63 @@ end
 redirect_to "/auth/proconnect/logout"
 ```
 
+## Informations retournées
+
+Les [informations retournées par
+ProConnect](https://partenaires.proconnect.gouv.fr/docs/fournisseur-service/scope-claims)
+sont mises à diposition dans le hash OmniAuth
+(`request.env["omniauth.auth"]`) :
+
+- la partie `info` contient tout ce qui peut être standardisé [selon
+  le Auth Hash Schema d'Omniauth](https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema)
+- le reste/l'intégralité est disponible dans `extra`.
+
+Exemple :
+
+```json
+{
+  "provider": "proconnect",
+  "uid": "e7a41249-123d-46b7-b362-5f00d3166ea1",
+  "info": {
+    "email": "test@gouv.fr",
+    "first_name": null,
+    "last_name": null,
+    "name": "",
+    "phone": null,
+    "provider": "proconnect",
+    "uid": "e7a41249-123d-46b7-b362-5f00d3166ea1"
+  },
+  "credentials": {},
+  "extra": {
+    "raw_info": {
+      "sub": "e7a41249-123d-46b7-b362-5f00d3166ea1",
+      "email": "test@gouv.fr",
+      "siret": "13002526500013",
+      "aud": "f90c1231117ec6f731af9f93a07c54ff372130c17a3bbad43488699865d85c64",
+      "exp": 1748010049,
+      "iat": 1748009989,
+      "iss": "https://issuer-oidc.gouv.fr/api/v42"
+    }
+  }
+}
+```
+
+```ruby
+class SessionsController < ApplicationController
+  def create
+    data = request.env["omniauth.auth"]
+
+    email = data.info.email
+    siret = data.extra.raw_info.siret
+
+    # or, if you're feeling fancy
+    data => { info: { email: }, extra: { raw_info: { siret: } } }
+
+    # [...]
+  end
+end
+```
+
 ## Contribution
 
 La stratégie est loin d'être complète ; n'hésitez pas à contribuer des

data/lib/omniauth/proconnect/version.rb

@@ -2,6 +2,6 @@
 
 module Omniauth
   class Proconnect
-    VERSION = "0.3.0"
+    VERSION = "0.5"
   end
 end

data/lib/omniauth/proconnect.rb

@@ -47,20 +47,33 @@ module OmniAuth
         end
       end
 
-      def uid
-        session["omniauth.pc.id_token"]["sub"]
+      # userinfo-operating DSL from OmniAuth
+      uid do
+        @userinfo["sub"]
       end
 
-      def info
+      info do
         {
-          email: @userinfo["email"]
+          email: @userinfo["email"],
+          first_name: @userinfo["given_name"],
+          last_name: @userinfo["usual_name"],
+          name: [@userinfo["given_name"], @userinfo["usual_name"]].compact.join(" "),
+          phone: @userinfo["phone_number"],
+          provider: "proconnect",
+          uid: @userinfo["sub"]
         }
       end
 
+      extra do
+        { raw_info: @userinfo }
+      end
+
       private
 
       def connection
         @connection ||= Faraday.new(url: options[:proconnect_domain]) do |c|
+          c.request :url_encoded
+
           c.response :json
           c.response :raise_error
         end
@@ -71,9 +84,7 @@ module OmniAuth
       end
 
       def discover_endpoint!
-        connection
-          .get(".well-known/openid-configuration")
-          .body
+        connection.get(".well-known/openid-configuration").body
       end
 
       def authorization_uri
@@ -147,9 +158,11 @@ module OmniAuth
       end
 
       def verify_state!(other_state)
+        # rubocop:disable Style/GuardClause
         if other_state != current_state
           raise "a request came back with a different 'state' parameter than what we had last stored."
         end
+        # rubocop:enable Style/GuardClause
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-proconnect
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: '0.5'
 platform: ruby
 authors:
 - Stéphane Maniaci
 bindir: exe
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2025-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,8 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An OmniAuth strategy for ProConnect, an official OIDC solution for French
-  professionnals to login.
+description: |
+  An OmniAuth strategy for ProConnect, an official
+  OIDC solution for French professionnals to login.
 email:
 - stephane.maniaci@gmail.com
 executables: []
@@ -61,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - LICENSE.txt
 - README.md
 - Rakefile