SWAMPy

✎ CARVE FLESH

EDITING: oauth_2.rb

# Copyright (C) 2010 Google Inc.
#
#    Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.

require "base64"
require "signet"
require "multi_json"

module Signet #:nodoc:
  ##
  # An implementation of http://tools.ietf.org/html/draft-ietf-oauth-v2-10
  #
  # This module will be updated periodically to support newer drafts of the
  # specification, as they become widely deployed.
  module OAuth2
    def self.parse_authorization_header field_value
      auth_scheme = field_value[/^([-._0-9a-zA-Z]+)/, 1]
      case auth_scheme
      when /^Basic$/i
        # HTTP Basic is allowed in OAuth 2
        parse_basic_credentials(field_value[/^Basic\s+(.*)$/i, 1])
      when /^OAuth$/i
        # Other token types may be supported eventually
        parse_bearer_credentials(field_value[/^OAuth\s+(.*)$/i, 1])
      else
        raise ParseError,
              "Parsing non-OAuth Authorization headers is out of scope."
      end
    end

def self.parse_www_authenticate_header field_value
      auth_scheme = field_value[/^([-._0-9a-zA-Z]+)/, 1]
      case auth_scheme
      when /^OAuth$/i
        # Other token types may be supported eventually
        parse_oauth_challenge(field_value[/^OAuth\s+(.*)$/i, 1])
      else
        raise ParseError,
              "Parsing non-OAuth WWW-Authenticate headers is out of scope."
      end
    end

def self.parse_basic_credentials credential_string
      decoded = Base64.decode64 credential_string
      client_id, client_secret = decoded.split ":", 2
      [["client_id", client_id], ["client_secret", client_secret]]
    end

def self.parse_bearer_credentials credential_string
      access_token = credential_string[/^([^,\s]+)(?:\s|,|$)/i, 1]
      parameters = []
      parameters << ["access_token", access_token]
      auth_param_string = credential_string[/^(?:[^,\s]+)\s*,\s*(.*)$/i, 1]
      if auth_param_string
        # This code will rarely get called, but is included for completeness
        parameters.concat Signet.parse_auth_param_list(auth_param_string)
      end
      parameters
    end

def self.parse_oauth_challenge challenge_string
      Signet.parse_auth_param_list challenge_string
    end

def self.parse_credentials body, content_type
      raise TypeError, "Expected String, got #{body.class}." unless body.is_a? String
      case content_type
      when %r{^application/json.*}
        MultiJson.load body
      when %r{^application/x-www-form-urlencoded.*}
        Hash[Addressable::URI.form_unencode(body)]
      else
        raise ArgumentError, "Invalid content type '#{content_type}'"
      end
    end

##
    # Generates a Basic Authorization header from a client identifier and a
    # client password.
    #
    # @param [String] client_id
    #   The client identifier.
    # @param [String] client_password
    #   The client password.
    #
    # @return [String]
    #   The value for the HTTP Basic Authorization header.
    def self.generate_basic_authorization_header client_id, client_password
      if client_id =~ /:/
        raise ArgumentError,
              "A client identifier may not contain a ':' character."
      end
      token = Base64.encode64("#{client_id}:#{client_password}").delete("\n")
      "Basic #{token}"
    end

##
    # Generates an authorization header for an access token
    #
    # @param [String] access_token
    #   The access token.
    # @param [Hash] auth_params
    #   Additional parameters to be encoded in the header
    #
    # @return [String]
    #   The value for the HTTP Basic Authorization header.
    def self.generate_bearer_authorization_header \
      access_token, auth_params = nil

# TODO: escaping?
      header = "Bearer #{access_token}"
      if auth_params && !auth_params.empty?
        additional_headers = auth_params.map { |key, value| "#{key}=\"#{value}\"" }
        header = ([header] + additional_headers).join ", "
      end
      header
    end

##
    # Appends the necessary OAuth parameters to
    # the base authorization endpoint URI.
    #
    # @param [Addressable::URI, String, #to_str] authorization_uri
    #   The base authorization endpoint URI.
    #
    # @return [String] The authorization URI to redirect the user to.
    def self.generate_authorization_uri authorization_uri, parameters = {}
      parameters.each do |key, value|
        parameters.delete key if value.nil?
      end
      parsed_uri = Addressable::URI.parse(authorization_uri).dup
      query_values = parsed_uri.query_values || {}
      query_values = query_values.merge parameters
      parsed_uri.query_values = query_values
      parsed_uri.normalize.to_s
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 oauth_1/	DIR	—	2023-09-24 03:48
📁 oauth_2/	DIR	—	2023-09-24 03:48
📄 errors.rb	RB	2.9 KB	2023-09-24 03:48	EDIT
📄 oauth_1.rb	RB	16.8 KB	2023-09-24 03:48	EDIT
📄 oauth_2.rb	RB	5.1 KB	2023-09-24 03:48	EDIT
📄 version.rb	RB	653 B	2023-09-24 03:48	EDIT