Class: OAuth2::Authenticator + + + +
+
+
+
+
+-
+
- Inherits: +
-
+ Object
+
+
-
+
- Object + +
- OAuth2::Authenticator + +
+
-
+
- Includes: +
- FilteredAttributes +
-
+
- Defined in: +
- lib/oauth2/authenticator.rb + +
Overview
+
+
+
+
+
+
+
+Builds and applies client authentication to token and revoke requests.
+ +Depending on the selected mode, credentials are applied as Basic Auth
+headers, request body parameters, or only the client_id is sent (TLS).
Instance Attribute Summary collapse
+-
+
+
-
+
+
+ #id ⇒ Symbol, ...
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+ ++ +
+
+
+
-
+
+
+ #mode ⇒ Symbol, ...
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+ ++ +
+
+
+
-
+
+
+ #secret ⇒ Symbol, ...
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+ ++ +
+
+
+
+ Class Method Summary + collapse +
+ +-
+
+
-
+
+
+ .encode_basic_auth(user, password) ⇒ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + +
Encodes a Basic Authorization header value for the provided credentials.
+
+
+
+
+ Instance Method Summary + collapse +
+ +-
+
+
-
+
+
+ #apply(params) ⇒ Hash
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + +
Apply the request credentials used to authenticate to the Authorization Server.
+
+
+
+ -
+
+
+ #initialize(id, secret, mode) ⇒ Authenticator
+
+
+
+
+
+
+ constructor
+
+
+
+
+
+
+
+
+ + +
Create a new Authenticator.
+
+
+
+
+
+
+ Constructor Details
+ +
+
+
+
+
++ + #initialize(id, secret, mode) ⇒ Authenticator + + + + + +
+
+
+
+Create a new Authenticator
+ + +
+ + + +24 +25 +26 +27 +28+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 24 + +def initialize(id, secret, mode) + @id = id + @secret = secret + @mode = mode +end+ |
+
+
+
+
+ Instance Attribute Details
+ + + +
+
+
+
+
+
+
+ + + #id ⇒ Symbol, ... (readonly) + + + + + +
+
+
+
+
+
+
+
+ + + +16 +17 +18+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 16 + +def id + @id +end+ |
+
+
+
+
+
+
+
+ + + #mode ⇒ Symbol, ... (readonly) + + + + + +
+
+
+
+
+
+
+
+ + + +16 +17 +18+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 16 + +def mode + @mode +end+ |
+
+
+
+
+
+ + + #secret ⇒ Symbol, ... (readonly) + + + + + +
+
+
+
+
+
+
+
+ + + +16 +17 +18+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 16 + +def secret + @secret +end+ |
+
+
+
+ Class Method Details
+ + +
+
+
+
+
+ + + .encode_basic_auth(user, password) ⇒ String + + + + + +
+
+
+
+Encodes a Basic Authorization header value for the provided credentials.
+ + +
+ + + +60 +61 +62+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 60 + +def encode_basic_auth(user, password) + "Basic #{Base64.strict_encode64("#{user}:#{password}")}" +end+ |
+
+
+
+Instance Method Details
+ + +
+
+
+
+
+ + + #apply(params) ⇒ Hash + + + + + +
+
+
+
+Apply the request credentials used to authenticate to the Authorization Server
+ +Depending on the configuration, this might be as request params or as an
+Authorization header.
User-provided params and header take precedence.
+ + +
+ + + +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52+ |
+
+ # File 'lib/oauth2/authenticator.rb', line 39 + +def apply(params) + case mode.to_sym + when :basic_auth + apply_basic_auth(params) + when :request_body + apply_params_auth(params) + when :tls_client_auth + apply_client_id(params) + when :private_key_jwt + params + else + raise NotImplementedError + end +end+ |
+