/usr/lib/ruby/vendor_ruby/mixlib/authentication/signedheaderauth.rb is in ruby-mixlib-authentication 1.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | #
# Author:: Christopher Brown (<cb@opscode.com>)
# Author:: Christopher Walters (<cw@opscode.com>)
# Copyright:: Copyright (c) 2009, 2010 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# 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 "time"
require "base64"
require "openssl/digest"
require "mixlib/authentication"
require "mixlib/authentication/digester"
module Mixlib
module Authentication
module SignedHeaderAuth
NULL_ARG = Object.new
ALGORITHM_FOR_VERSION = {
"1.0" => "sha1",
"1.1" => "sha1",
"1.3" => "sha256",
}.freeze()
# Use of SUPPORTED_ALGORITHMS and SUPPORTED_VERSIONS is deprecated. Use
# ALGORITHM_FOR_VERSION instead
SUPPORTED_ALGORITHMS = ["sha1"].freeze
SUPPORTED_VERSIONS = ["1.0", "1.1"].freeze
DEFAULT_SIGN_ALGORITHM = "sha1".freeze
DEFAULT_PROTO_VERSION = "1.0".freeze
# === signing_object
# This is the intended interface for signing requests with the
# Opscode/Chef signed header protocol. This wraps the constructor for a
# Struct that contains the relevant information about your request.
#
# ==== Signature Parameters:
# These parameters are used to generate the canonical representation of
# the request, which is then hashed and encrypted to generate the
# request's signature. These options are all required, with the exception
# of `:body` and `:file`, which are alternate ways to specify the request
# body (you must specify one of these).
# * `:http_method`: HTTP method as a lowercase symbol, e.g., `:get | :put | :post | :delete`
# * `:path`: The path part of the URI, e.g., `URI.parse(uri).path`
# * `:body`: An object representing the body of the request.
# Use an empty String for bodiless requests.
# * `:timestamp`: A String representing the time in any format understood
# by `Time.parse`. The server may reject the request if the timestamp is
# not close to the server's current time.
# * `:user_id`: The user or client name. This is used by the server to
# lookup the public key necessary to verify the signature.
# * `:file`: An IO object (must respond to `:read`) to be used as the
# request body.
# ==== Protocol Versioning Parameters:
# * `:proto_version`: The version of the signing protocol to use.
# Currently defaults to 1.0, but version 1.1 is also available.
# ==== Other Parameters:
# These parameters are accepted but not used in the computation of the signature.
# * `:host`: The host part of the URI
def self.signing_object(args = {})
SigningObject.new(args[:http_method],
args[:path],
args[:body],
args[:host],
args[:timestamp],
args[:user_id],
args[:file],
args[:proto_version],
args[:headers]
)
end
def algorithm
ALGORITHM_FOR_VERSION[proto_version] || DEFAULT_SIGN_ALGORITHM
end
def proto_version
DEFAULT_PROTO_VERSION
end
# Build the canonicalized request based on the method, other headers, etc.
# compute the signature from the request, using the looked-up user secret
# ====Parameters
# private_key<OpenSSL::PKey::RSA>:: user's RSA private key.
def sign(private_key, sign_algorithm = algorithm, sign_version = proto_version)
digest = validate_sign_version_digest!(sign_algorithm, sign_version)
# Our multiline hash for authorization will be encoded in multiple header
# lines - X-Ops-Authorization-1, ... (starts at 1, not 0!)
header_hash = {
"X-Ops-Sign" => "algorithm=#{sign_algorithm};version=#{sign_version};",
"X-Ops-Userid" => user_id,
"X-Ops-Timestamp" => canonical_time,
"X-Ops-Content-Hash" => hashed_body(digest),
}
signature = Base64.encode64(do_sign(private_key, digest, sign_algorithm, sign_version)).chomp
signature_lines = signature.split(/\n/)
signature_lines.each_index do |idx|
key = "X-Ops-Authorization-#{idx + 1}"
header_hash[key] = signature_lines[idx]
end
Mixlib::Authentication::Log.debug "Header hash: #{header_hash.inspect}"
header_hash
end
def validate_sign_version_digest!(sign_algorithm, sign_version)
if ALGORITHM_FOR_VERSION[sign_version].nil?
raise AuthenticationError,
"Unsupported version '#{sign_version}'"
end
if ALGORITHM_FOR_VERSION[sign_version] != sign_algorithm
raise AuthenticationError,
"Unsupported algorithm #{sign_algorithm} for version '#{sign_version}'"
end
case sign_algorithm
when "sha1"
OpenSSL::Digest::SHA1
when "sha256"
OpenSSL::Digest::SHA256
else
# This case should never happen
raise "Unknown algorithm #{sign_algorithm}"
end
end
# Build the canonicalized time based on utc & iso8601
#
# ====Parameters
#
def canonical_time
Time.parse(timestamp).utc.iso8601
end
# Build the canonicalized path, which collapses multiple slashes (/) and
# removes a trailing slash unless the path is only "/"
#
# ====Parameters
#
def canonical_path
p = path.gsub(/\/+/, "/")
p.length > 1 ? p.chomp("/") : p
end
def hashed_body(digest = OpenSSL::Digest::SHA1)
# This is weird. sign() is called with the digest type and signing
# version. These are also expected to be properties of the object.
# Hence, we're going to assume the one that is passed to sign is
# the correct one and needs to passed through all the functions
# that do any sort of digest.
if @hashed_body_digest != nil && @hashed_body_digest != digest
raise "hashed_body must always be called with the same digest"
else
@hashed_body_digest = digest
end
# Hash the file object if it was passed in, otherwise hash based on
# the body.
# TODO: tim 2009-12-28: It'd be nice to just remove this special case,
# always sign the entire request body, using the expanded multipart
# body in the case of a file being include.
@hashed_body ||= if self.file && self.file.respond_to?(:read)
digester.hash_file(self.file, digest)
else
digester.hash_string(self.body, digest)
end
end
# Takes HTTP request method & headers and creates a canonical form
# to create the signature
#
# ====Parameters
#
#
def canonicalize_request(sign_algorithm = algorithm, sign_version = proto_version)
digest = validate_sign_version_digest!(sign_algorithm, sign_version)
canonical_x_ops_user_id = canonicalize_user_id(user_id, sign_version, digest)
case sign_version
when "1.3"
[
"Method:#{http_method.to_s.upcase}",
"Path:#{canonical_path}",
"X-Ops-Content-Hash:#{hashed_body(digest)}",
"X-Ops-Sign:version=#{sign_version}",
"X-Ops-Timestamp:#{canonical_time}",
"X-Ops-UserId:#{canonical_x_ops_user_id}",
"X-Ops-Server-API-Version:#{server_api_version}",
].join("\n")
else
[
"Method:#{http_method.to_s.upcase}",
"Hashed Path:#{digester.hash_string(canonical_path, digest)}",
"X-Ops-Content-Hash:#{hashed_body(digest)}",
"X-Ops-Timestamp:#{canonical_time}",
"X-Ops-UserId:#{canonical_x_ops_user_id}",
].join("\n")
end
end
def canonicalize_user_id(user_id, proto_version, digest = OpenSSL::Digest::SHA1)
case proto_version
when "1.1"
# and 1.2 if that ever gets implemented
digester.hash_string(user_id, digest)
else
# versions 1.0 and 1.3
user_id
end
end
# Parses signature version information, algorithm used, etc.
#
# ====Parameters
#
def parse_signing_description
parts = signing_description.strip.split(";").inject({}) do |memo, part|
field_name, field_value = part.split("=")
memo[field_name.to_sym] = field_value.strip
memo
end
Mixlib::Authentication::Log.debug "Parsed signing description: #{parts.inspect}"
parts
end
def digester
Mixlib::Authentication::Digester
end
# private
def do_sign(private_key, digest, sign_algorithm, sign_version)
string_to_sign = canonicalize_request(sign_algorithm, sign_version)
Mixlib::Authentication::Log.debug "String to sign: '#{string_to_sign}'"
case sign_version
when "1.3"
private_key.sign(digest.new, string_to_sign)
else
private_key.private_encrypt(string_to_sign)
end
end
private :canonical_time, :canonical_path, :parse_signing_description, :digester, :canonicalize_user_id
end
# === SigningObject
# A Struct-based value object that contains the necessary information to
# generate a request signature. `SignedHeaderAuth.signing_object()`
# provides a more convenient interface to the constructor.
class SigningObject < Struct.new(:http_method, :path, :body, :host,
:timestamp, :user_id, :file, :proto_version,
:headers)
include SignedHeaderAuth
def proto_version
(self[:proto_version] || DEFAULT_PROTO_VERSION).to_s
end
def server_api_version
key = (self[:headers] || {}).keys.select do |k|
k.downcase == "x-ops-server-api-version"
end.first
if key
self[:headers][key]
else
DEFAULT_SERVER_API_VERSION
end
end
end
end
end
|