|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require_relative "gs2_header" |
| 4 | + |
| 5 | +module Net |
| 6 | + class IMAP < Protocol |
| 7 | + module SASL |
| 8 | + |
| 9 | + # Abstract base class for the SASL mechanisms defined in |
| 10 | + # RFC7628[https://tools.ietf.org/html/rfc7628]: |
| 11 | + # * OAUTHBEARER[rdoc-ref:OAuthBearerAuthenticator] |
| 12 | + # (OAuthBearerAuthenticator) |
| 13 | + # * OAUTH10A |
| 14 | + class OAuthAuthenticator |
| 15 | + include GS2Header |
| 16 | + |
| 17 | + # Creates an RFC7628[https://tools.ietf.org/html/rfc7628] OAuth |
| 18 | + # authenticator. |
| 19 | + # |
| 20 | + # === Options |
| 21 | + # |
| 22 | + # See child classes for required configuration parameter(s). The |
| 23 | + # following parameters are all optional, but protocols or servers may |
| 24 | + # add requirements for #authzid, #host, #port, or any other parameter. |
| 25 | + # |
| 26 | + # * #authzid ― Identity to act as or on behalf of. |
| 27 | + # * #host — Hostname to which the client connected. |
| 28 | + # * #port — Service port to which the client connected. |
| 29 | + # * #mthd — HTTP method |
| 30 | + # * #path — HTTP path data |
| 31 | + # * #post — HTTP post data |
| 32 | + # * #qs — HTTP query string |
| 33 | + # |
| 34 | + def initialize(authzid: nil, host: nil, port: nil, |
| 35 | + mthd: nil, path: nil, post: nil, qs: nil, **) |
| 36 | + @authzid = authzid |
| 37 | + @host = host |
| 38 | + @port = port |
| 39 | + @mthd = mthd |
| 40 | + @path = path |
| 41 | + @post = post |
| 42 | + @qs = qs |
| 43 | + @done = false |
| 44 | + end |
| 45 | + |
| 46 | + # Authorization identity: an identity to act as or on behalf of. |
| 47 | + # |
| 48 | + # If no explicit authorization identity is provided, it is usually |
| 49 | + # derived from the authentication identity. For the OAuth-based |
| 50 | + # mechanisms, the authentication identity is the identity established by |
| 51 | + # the OAuth credential. |
| 52 | + attr_reader :authzid |
| 53 | + |
| 54 | + # Hostname to which the client connected. |
| 55 | + attr_reader :host |
| 56 | + |
| 57 | + # Service port to which the client connected. |
| 58 | + attr_reader :port |
| 59 | + |
| 60 | + # HTTP method. (optional) |
| 61 | + attr_reader :mthd |
| 62 | + |
| 63 | + # HTTP path data. (optional) |
| 64 | + attr_reader :path |
| 65 | + |
| 66 | + # HTTP post data. (optional) |
| 67 | + attr_reader :post |
| 68 | + |
| 69 | + # The query string. (optional) |
| 70 | + attr_reader :qs |
| 71 | + |
| 72 | + # Stores the most recent server "challenge". When authentication fails, |
| 73 | + # this may hold information about the failure reason, as JSON. |
| 74 | + attr_reader :last_server_response |
| 75 | + |
| 76 | + # Returns initial_client_response the first time, then "<tt>^A</tt>". |
| 77 | + def process(data) |
| 78 | + @last_server_response = data |
| 79 | + done? ? "\1" : initial_client_response |
| 80 | + ensure |
| 81 | + @done = true |
| 82 | + end |
| 83 | + |
| 84 | + # Returns true when the initial client response was sent. |
| 85 | + # |
| 86 | + # The authentication should not succeed unless this returns true, but it |
| 87 | + # does *not* indicate success. |
| 88 | + def done?; @done end |
| 89 | + |
| 90 | + # The {RFC7628 §3.1}[https://www.rfc-editor.org/rfc/rfc7628#section-3.1] |
| 91 | + # formatted response. |
| 92 | + def initial_client_response |
| 93 | + kv_pairs = { |
| 94 | + host: host, port: port, mthd: mthd, path: path, post: post, qs: qs, |
| 95 | + auth: authorization, # authorization is implemented by subclasses |
| 96 | + }.compact |
| 97 | + [gs2_header, *kv_pairs.map {|kv| kv.join("=") }, "\1"].join("\1") |
| 98 | + end |
| 99 | + |
| 100 | + # Value of the HTTP Authorization header |
| 101 | + # |
| 102 | + # <b>Implemented by subclasses.</b> |
| 103 | + def authorization; raise "must be implemented by subclass" end |
| 104 | + |
| 105 | + end |
| 106 | + |
| 107 | + # Authenticator for the "+OAUTHBEARER+" SASL mechanism, specified in |
| 108 | + # RFC7628[https://tools.ietf.org/html/rfc7628]. Authenticates using OAuth |
| 109 | + # 2.0 bearer tokens, as described in |
| 110 | + # RFC6750[https://tools.ietf.org/html/rfc6750]. Use via |
| 111 | + # Net::IMAP#authenticate. |
| 112 | + # |
| 113 | + # RFC6750[https://tools.ietf.org/html/rfc6750] requires Transport Layer |
| 114 | + # Security (TLS) to secure the protocol interaction between the client and |
| 115 | + # the resource server. TLS _MUST_ be used for +OAUTHBEARER+ to protect |
| 116 | + # the bearer token. |
| 117 | + class OAuthBearerAuthenticator < OAuthAuthenticator |
| 118 | + |
| 119 | + # :call-seq: |
| 120 | + # new(oauth2_token, **options) -> authenticator |
| 121 | + # new(oauth2_token:, **options) -> authenticator |
| 122 | + # |
| 123 | + # Creates an Authenticator for the "+OAUTHBEARER+" SASL mechanism. |
| 124 | + # |
| 125 | + # Called by Net::IMAP#authenticate and similar methods on other clients. |
| 126 | + # |
| 127 | + # === Options |
| 128 | + # |
| 129 | + # Only +oauth2_token+ is required by the mechanism, however protocols |
| 130 | + # and servers may add requirements for #authzid, #host, #port, or any |
| 131 | + # other parameter. |
| 132 | + # |
| 133 | + # * #oauth2_token — An OAuth2 bearer token or access token. *Required.* |
| 134 | + # May be provided as either regular or keyword argument. |
| 135 | + # * #authzid ― Identity to act as or on behalf of. |
| 136 | + # * #host — Hostname to which the client connected. |
| 137 | + # * #port — Service port to which the client connected. |
| 138 | + # * See OAuthAuthenticator documentation for less common parameters. |
| 139 | + # |
| 140 | + def initialize(oauth2_token_arg = nil, oauth2_token: nil, **args, &blk) |
| 141 | + super(**args, &blk) # handles authzid, host, port, etc |
| 142 | + oauth2_token && oauth2_token_arg and |
| 143 | + raise ArgumentError, "conflicting values for oauth2_token" |
| 144 | + @oauth2_token = oauth2_token || oauth2_token_arg or |
| 145 | + raise ArgumentError, "missing oauth2_token" |
| 146 | + end |
| 147 | + |
| 148 | + # An OAuth2 bearer token, generally the access token. |
| 149 | + attr_reader :oauth2_token |
| 150 | + |
| 151 | + # :call-seq: |
| 152 | + # initial_response? -> true |
| 153 | + # |
| 154 | + # +OAUTHBEARER+ sends an initial client response. |
| 155 | + def initial_response?; true end |
| 156 | + |
| 157 | + # Value of the HTTP Authorization header |
| 158 | + def authorization; "Bearer #{oauth2_token}" end |
| 159 | + |
| 160 | + end |
| 161 | + end |
| 162 | + |
| 163 | + end |
| 164 | +end |
0 commit comments