|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require_relative "authenticator" |
| 4 | +require_relative "gs2_header" |
| 5 | + |
| 6 | +module Net |
| 7 | + class IMAP < Protocol |
| 8 | + module SASL |
| 9 | + |
| 10 | + # Abstract base class for the SASL mechanisms defined in |
| 11 | + # RFC7628[https://tools.ietf.org/html/rfc7628]: |
| 12 | + # * OAUTHBEARER[rdoc-ref:OAuthBearerAuthenticator] |
| 13 | + # * OAUTH10A |
| 14 | + class OAuthAuthenticator < Authenticator |
| 15 | + include GS2Header |
| 16 | + |
| 17 | + # <b>Implemented by subclasses.</b> |
| 18 | + def self.mechanism_name; raise NotImplementedError end |
| 19 | + |
| 20 | + # Creates an OAuthBearerAuthenticator or OAuth10aAuthenticator. |
| 21 | + # |
| 22 | + # * +_subclass_var_+ — the subclass's required parameter. |
| 23 | + # * #authzid ― Identity to act as or on behalf of. |
| 24 | + # * #host — Hostname to which the client connected. |
| 25 | + # * #port — Service port to which the client connected. |
| 26 | + # * #mthd — HTTP method |
| 27 | + # * #path — HTTP path data |
| 28 | + # * #post — HTTP post data |
| 29 | + # * #qs — HTTP query string |
| 30 | + # |
| 31 | + # All properties here are optional. See the child classes for their |
| 32 | + # required parameter(s). |
| 33 | + # |
| 34 | + def initialize(arg1_authzid = nil, _ = nil, arg3_authzid = nil, |
| 35 | + authzid: nil, host: nil, port: nil, |
| 36 | + mthd: nil, path: nil, post: nil, qs: nil, **) |
| 37 | + super |
| 38 | + propinit(:authzid, authzid, arg1_authzid, arg3_authzid) |
| 39 | + self.host = host |
| 40 | + self.port = port |
| 41 | + self.mthd = mthd |
| 42 | + self.path = path |
| 43 | + self.post = post |
| 44 | + self.qs = qs |
| 45 | + @done = false |
| 46 | + end |
| 47 | + |
| 48 | + ## |
| 49 | + # Authorization identity: an identity to act as or on behalf of. |
| 50 | + # |
| 51 | + # For the OAuth-based mechanisms, authcid is implicitly set by the |
| 52 | + # #auth_payload. It may be useful to make it explicit, which allows the |
| 53 | + # server to verify the credentials match the identity. The gs2_header |
| 54 | + # MAY include the username associated with the resource being accessed, |
| 55 | + # the "authzid". |
| 56 | + # |
| 57 | + # It is worth noting that application protocols are allowed to require |
| 58 | + # an authzid, as are specific server implementations. |
| 59 | + # |
| 60 | + # See also: PlainAuthenticator#authzid, DigestMD5Authenticator#authzid. |
| 61 | + property :authzid |
| 62 | + |
| 63 | + ## |
| 64 | + # Hostname to which the client connected. |
| 65 | + property :host |
| 66 | + |
| 67 | + ## |
| 68 | + # Service port to which the client connected. |
| 69 | + property :port |
| 70 | + |
| 71 | + ## |
| 72 | + # HTTP method. (optional) |
| 73 | + property :mthd |
| 74 | + |
| 75 | + ## |
| 76 | + # HTTP path data. (optional) |
| 77 | + property :path |
| 78 | + |
| 79 | + ## |
| 80 | + # HTTP post data. (optional) |
| 81 | + property :post |
| 82 | + |
| 83 | + ## |
| 84 | + # The query string. (optional) |
| 85 | + property :qs |
| 86 | + |
| 87 | + # Stores the most recent server "challenge". When authentication fails, |
| 88 | + # this may hold information about the failure reason, as JSON. |
| 89 | + attr_reader :last_server_response |
| 90 | + |
| 91 | + ## |
| 92 | + # Returns initial_client_response the first time, then "<tt>^A</tt>". |
| 93 | + def process(data) |
| 94 | + @last_server_response = data |
| 95 | + return "\1" if done? |
| 96 | + initial_client_response |
| 97 | + ensure |
| 98 | + @done = true |
| 99 | + end |
| 100 | + |
| 101 | + ## |
| 102 | + # Returns true when the initial client response was sent. |
| 103 | + # |
| 104 | + # The authentication should not succeed unless this returns true, but it |
| 105 | + # does *not* indicate success. |
| 106 | + def done?; @done end |
| 107 | + |
| 108 | + # The {RFC7628 §3.1}[https://www.rfc-editor.org/rfc/rfc7628#section-3.1] |
| 109 | + # formatted response. |
| 110 | + def initial_client_response |
| 111 | + [gs2_header, *kv_pairs.map {|kv| kv.join("=") }, "\1"].join("\1") |
| 112 | + end |
| 113 | + |
| 114 | + # The key value pairs which follow gs2_header, as a Hash. |
| 115 | + def kv_pairs |
| 116 | + { |
| 117 | + host: host, port: port, mthd: mthd, path: path, post: post, qs: qs, |
| 118 | + auth: auth_payload, # auth_payload is implemented by subclasses |
| 119 | + }.compact |
| 120 | + end |
| 121 | + |
| 122 | + # What would be sent in the HTTP Authorization header. |
| 123 | + # |
| 124 | + # <b>Implemented by subclasses.</b> |
| 125 | + def auth_payload; raise NotImplementedError, "implement in subclass" end |
| 126 | + |
| 127 | + end |
| 128 | + |
| 129 | + # Authenticator for the "+OAUTHBEARER+" SASL mechanism, specified in |
| 130 | + # RFC7628[https://tools.ietf.org/html/rfc7628]. Use via |
| 131 | + # Net::IMAP#authenticate. |
| 132 | + # |
| 133 | + # TODO... |
| 134 | + # |
| 135 | + # OAuth 2.0 bearer tokens, as described in [RFC6750]. |
| 136 | + # RFC6750 uses Transport Layer Security (TLS) [RFC5246] to |
| 137 | + # secure the protocol interaction between the client and the |
| 138 | + # resource server. |
| 139 | + # |
| 140 | + # TLS MUST be used for +OAUTHBEARER+ to protect the bearer token. |
| 141 | + class OAuthBearerAuthenticator < OAuthAuthenticator |
| 142 | + # +OAUTHBEARER+ |
| 143 | + def self.mechanism_name; "OAUTHBEARER" end |
| 144 | + register Net::IMAP |
| 145 | + |
| 146 | + ## |
| 147 | + # :call-seq: |
| 148 | + # new(authzid, oauth2_token, **) -> auth_ctx |
| 149 | + # new(oauth2_token:, authzid: nil, **) -> auth_ctx |
| 150 | + # new(**) {|propname, auth_ctx| propval } -> auth_ctx |
| 151 | + # |
| 152 | + # Creates an Authenticator for the "+OAUTHBEARER+" SASL mechanism. |
| 153 | + # |
| 154 | + # Called by Net::IMAP#authenticate and similar methods on other clients. |
| 155 | + # |
| 156 | + # === Properties |
| 157 | + # |
| 158 | + # * #oauth2_token — An OAuth2 bearer token or access token. *Required* |
| 159 | + # * #authzid ― Identity to act as or on behalf of. |
| 160 | + # * #host — Hostname to which the client connected. |
| 161 | + # * #port — Service port to which the client connected. |
| 162 | + # * See other, rarely used properties on OAuthAuthenticator. |
| 163 | + # |
| 164 | + # Although only #oauth2_token is required, specific server |
| 165 | + # implementations may additionally require #authzid, #host, and #port. |
| 166 | + # |
| 167 | + # See the documentation on each property method for more details. |
| 168 | + # |
| 169 | + # All three properties may be sent as either positional or keyword |
| 170 | + # arguments. See Net::IMAP::SASL::Authenticator@Properties for a |
| 171 | + # detailed description of property assignment, lazy loading, and |
| 172 | + # callbacks. |
| 173 | + # |
| 174 | + def initialize(id1=nil, arg2_token=nil, id3=nil, oauth2_token: nil, **) |
| 175 | + super # handles authzid, host, port, callback, etc |
| 176 | + propinit(:oauth2_token, oauth2_token, arg2_token, required: true) |
| 177 | + self.host = host |
| 178 | + end |
| 179 | + |
| 180 | + ## |
| 181 | + # An OAuth2 bearer token, which is generally the same as the standard |
| 182 | + # access_token. |
| 183 | + property :oauth2_token |
| 184 | + |
| 185 | + # :call-seq: |
| 186 | + # initial_response? -> true |
| 187 | + # |
| 188 | + # +OAUTHBEARER+ sends an initial client response. |
| 189 | + def initial_response?; true end |
| 190 | + |
| 191 | + # What would be sent in the HTTP Authorization header. |
| 192 | + def auth_payload; "Bearer #{oauth2_token}" end |
| 193 | + |
| 194 | + end |
| 195 | + end |
| 196 | + |
| 197 | + end |
| 198 | +end |
0 commit comments