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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
|
#' @param authInfo Typically an object created by `accountInfo()` augmented
#' with the `certificate` from the corresponding `serverInfo()`.
#'
#' There are three different fields used for auth:
#' * `secret`: set in `setAccountInfo()`
#' * `private_key`: set in `connectUser()`
#' * `apiKey`: set in `connectApiUser()`
#'
#' @noRd
httpRequest <- function(service,
authInfo,
method,
path,
query,
headers = list(),
timeout = NULL,
error_call = caller_env()) {
storeCookies(service, httpCookies())
path <- buildPath(service$path, path, query)
headers <- c(headers, authHeaders(authInfo, method, path), httpHeaders())
certificate <- requestCertificate(service$protocol, authInfo$certificate)
# perform request
http <- httpFunction()
httpResponse <- http(
protocol = service$protocol,
host = service$host,
port = service$port,
method = method,
path = path,
headers = headers,
timeout = timeout,
certificate = certificate
)
while (isRedirect(httpResponse$status)) {
service <- redirectService(service, httpResponse$location)
httpResponse <- http(
protocol = service$protocol,
host = service$host,
port = service$port,
method = method,
path = service$path,
headers = headers,
timeout = timeout,
certificate = certificate
)
}
handleResponse(httpResponse, error_call = error_call)
}
httpRequestWithBody <- function(service,
authInfo,
method,
path,
query = NULL,
contentType = NULL,
file = NULL,
content = NULL,
headers = list(),
error_call = caller_env()) {
if ((is.null(file) && is.null(content))) {
stop("You must specify either the file or content parameter.")
}
if ((!is.null(file) && !is.null(content))) {
stop("You must specify either the file or content parameter but not both.")
}
# if we have content then write it to a temp file before posting
if (!is.null(content)) {
file <- tempfile()
writeChar(content, file, eos = NULL, useBytes = TRUE)
}
storeCookies(service, httpCookies())
path <- buildPath(service$path, path, query)
headers <- c(headers, httpHeaders())
authed_headers <- c(headers, authHeaders(authInfo, method, path, file))
certificate <- requestCertificate(service$protocol, authInfo$certificate)
# perform request
http <- httpFunction()
httpResponse <- http(
protocol = service$protocol,
host = service$host,
port = service$port,
method = method,
path = path,
headers = authed_headers,
contentType = contentType,
contentFile = file,
certificate = certificate
)
while (isRedirect(httpResponse$status)) {
# This is a simplification of the spec, since we should preserve
# the method for 307 and 308, but that's unlikely to arise for our apps
# https://www.rfc-editor.org/rfc/rfc9110.html#name-redirection-3xx
service <- redirectService(service, httpResponse$location)
authed_headers <- c(headers, authHeaders(authInfo, "GET", service$path))
httpResponse <- http(
protocol = service$protocol,
host = service$host,
port = service$port,
method = "GET",
path = service$path,
headers = authed_headers,
certificate = certificate
)
httpResponse
}
handleResponse(httpResponse, error_call = error_call)
}
isRedirect <- function(status) {
status %in% c(301, 302, 307, 308)
}
redirectService <- function(service, location) {
if (grepl("^/", location)) {
service$path <- location
service
} else {
parseHttpUrl(location)
}
}
handleResponse <- function(response, error_call = caller_env()) {
url <- buildHttpUrl(response$req)
reportError <- function(msg) {
cli::cli_abort(
c("<{url}> failed with HTTP status {response$status}", msg),
class = c(paste0("rsconnect_http_", response$status), "rsconnect_http"),
call = error_call
)
}
if (isContentType(response$contentType, "application/json")) {
# parse json responses
if (nzchar(response$content)) {
json <- jsonlite::fromJSON(response$content, simplifyVector = FALSE)
} else {
json <- list()
}
if (response$status %in% 200:399) {
out <- json
} else if (!is.null(json$error)) {
reportError(unlist(json$error))
} else {
reportError(paste("Unexpected json response:", response$content))
}
} else if (isContentType(response$contentType, "text/html")) {
# extract body of html responses
body <- regexExtract(".*?<body>(.*?)</body>.*", response$content)
if (response$status >= 200 && response$status < 400) {
# Good response, return the body if we have one, or the content if not
if (!is.null(body)) {
out <- body
} else {
out <- response$content
}
} else {
# Error response
if (!is.null(body)) {
reportError(body)
} else {
reportError(response$content)
}
}
} else {
# otherwise just dump the whole thing
if (response$status %in% 200:399) {
out <- response$content
} else {
reportError(response$content)
}
}
attr(out, "httpContentType") <- response$contentType
attr(out, "httpUrl") <- url
out
}
# Wrappers for HTTP methods -----------------------------------------------
GET <- function(service,
authInfo,
path,
query = NULL,
headers = list(),
timeout = NULL) {
httpRequest(service, authInfo, "GET", path, query, headers, timeout)
}
DELETE <- function(service,
authInfo,
path,
query = NULL,
headers = list()) {
httpRequest(service, authInfo, "DELETE", path, query, headers)
}
POST <- function(service,
authInfo,
path,
query = NULL,
contentType = NULL,
file = NULL,
content = NULL,
headers = list()) {
# check if the request needs a body
if ((is.null(file) && is.null(content))) {
# no file or content, don't include a body with the request
httpRequest(service, authInfo, "POST", path, query, headers)
} else {
# include the request's data in the body
httpRequestWithBody(
service = service,
authInfo = authInfo,
method = "POST",
path = path,
query = query,
contentType = contentType,
file = file,
content = content,
headers = headers
)
}
}
POST_JSON <- function(service,
authInfo,
path,
json,
query = NULL,
headers = list()) {
POST(
service = service,
authInfo = authInfo,
path = path,
query = query,
contentType = "application/json",
content = toJSON(json),
headers = headers
)
}
PUT <- function(service,
authInfo,
path,
query = NULL,
contentType = NULL,
file = NULL,
content = NULL,
headers = list()) {
httpRequestWithBody(
service = service,
authInfo = authInfo,
method = "PUT",
path = path,
query = query,
contentType = contentType,
file = file,
content = content,
headers = headers
)
}
PUT_JSON <- function(service,
authInfo,
path,
json,
query = NULL,
headers = list()) {
PUT(
service = service,
authInfo = authInfo,
path = path,
query = query,
contentType = "application/json",
content = toJSON(json),
headers = headers
)
}
PATCH <- function(service,
authInfo,
path,
query = NULL,
contentType = NULL,
file = NULL,
content = NULL,
headers = list()) {
httpRequestWithBody(
service = service,
authInfo = authInfo,
method = "PATCH",
path = path,
query = query,
contentType = contentType,
file = file,
content = content,
headers = headers
)
}
PATCH_JSON <- function(service,
authInfo,
path,
json,
query = NULL,
headers = list()) {
PATCH(
service = service,
authInfo = authInfo,
path = path,
query = query,
contentType = "application/json",
content = toJSON(json),
headers = headers
)
}
# User options ------------------------------------------------------------
httpVerbose <- function() {
getOption("rsconnect.http.verbose", FALSE)
}
httpTraceJson <- function() {
getOption("rsconnect.http.trace.json", FALSE)
}
httpTrace <- function(method, path, time) {
if (getOption("rsconnect.http.trace", FALSE)) {
cat(method, " ", path, " ", as.integer(time[["elapsed"]] * 1000), "ms\n",
sep = ""
)
}
}
httpCookies <- function() {
getOption("rsconnect.http.cookies", character())
}
httpHeaders <- function() {
getOption("rsconnect.http.headers", character())
}
httpFunction <- function() {
httpType <- getOption("rsconnect.http", "libcurl")
if (is_string(httpType) && httpType != "libcurl") {
lifecycle::deprecate_warn(
"1.0.0",
I("The `rsconnect.http` option"),
details = c(
"It should no longer be necessary to set this option",
"If the default http handler doesn't work for you, please file an issue at <https://github.com/rstudio/rsconnect/issues>"
)
)
}
if (identical("libcurl", httpType)) {
httpLibCurl
} else if (identical("rcurl", httpType)) {
httpRCurl
} else if (identical("curl", httpType)) {
httpCurl
} else if (identical("internal", httpType)) {
httpInternal
} else if (is.function(httpType)) {
httpType
} else {
stop(paste(
"Invalid http option specified:", httpType,
". Valid values are libcurl, rcurl, curl, and internal"
))
}
}
# URL manipulation --------------------------------------------------------
parseHttpUrl <- function(urlText) {
matches <- regexec("(http|https)://([^:/#?]+)(?::(\\d+))?(.*)", urlText)
components <- regmatches(urlText, matches)[[1]]
if (length(components) == 0) {
stop("Invalid url: ", urlText)
}
url <- list()
url$protocol <- components[[2]]
url$host <- components[[3]]
url$port <- components[[4]]
url$path <- components[[5]]
url
}
buildHttpUrl <- function(x) {
colon <- if (!is.null(x$port) && nzchar(x$port)) ":"
paste0(x$protocol, "://", x$host, colon, x$port, x$path)
}
urlDecode <- function(x) {
curl::curl_unescape(x)
}
urlEncode <- function(x) {
if (inherits(x, "AsIs")) {
return(x)
}
RCurl::curlEscape(x)
}
buildPath <- function(apiPath, path, query = NULL) {
# prepend the service path
url <- paste(apiPath, path, sep = "")
# append the query
if (!is.null(query)) {
# URL encode query args
query <- utils::URLencode(query)
url <- paste(url, "?", query, sep = "")
}
url
}
queryString <- function(elements) {
stopifnot(is.list(elements))
elements <- elements[!sapply(elements, is.null)]
names <- curl::curl_escape(names(elements))
values <- vapply(elements, urlEncode, character(1))
if (length(elements) > 0) {
result <- paste0(names, "=", values, collapse = "&")
} else {
result <- ""
}
return(result)
}
# Auth --------------------------------------------------------------------
requestCertificate <- function(protocol, certificate = NULL) {
if (identical(protocol, "https")) {
createCertificateFile(certificate)
} else {
NULL
}
}
authHeaders <- function(authInfo, method, path, file = NULL) {
if (!is.null(authInfo$secret) || !is.null(authInfo$private_key)) {
signatureHeaders(authInfo, method, path, file)
} else if (!is.null(authInfo$apiKey)) {
list(`Authorization` = paste("Key", authInfo$apiKey))
} else {
# The value doesn't actually matter here, but the header needs to be set.
list(`X-Auth-Token` = "anonymous-access")
}
}
# https://github.com/rstudio/connect/wiki/token-authentication#request-signing-rsconnect
signatureHeaders <- function(authInfo, method, path, file = NULL) {
# headers to return
headers <- list()
# remove query string from path if necessary
path <- strsplit(path, "?", fixed = TRUE)[[1]][[1]]
# generate date
date <- rfc2616Date()
if (!is.null(authInfo$secret)) {
# the content hash is a string of hex characters when using secret.
md5 <- fileMD5(file)
# build canonical request
canonicalRequest <- paste(method, path, date, md5, sep = "\n")
# sign request using shared secret
decodedSecret <- openssl::base64_decode(authInfo$secret)
hmac <- openssl::sha256(canonicalRequest, key = decodedSecret)
signature <- paste(openssl::base64_encode(hmac), "; version=1", sep = "")
} else if (!is.null(authInfo$private_key)) {
# the raw content hash is base64 encoded hex values when using private key.
md5 <- openssl::base64_encode(fileMD5(file, raw = TRUE))
# build canonical request
canonicalRequest <- paste(method, path, date, md5, sep = "\n")
# sign request using local private key
private_key <- openssl::read_key(
openssl::base64_decode(authInfo$private_key),
der = TRUE
)
signature <- signRequestPrivateKey(private_key, canonicalRequest)
} else {
stop("can't sign request: no shared secret or private key")
}
# return headers
headers$Date <- date
headers$`X-Auth-Token` <- authInfo$token
headers$`X-Auth-Signature` <- signature
headers$`X-Content-Checksum` <- md5
headers
}
signRequestPrivateKey <- function(private_key, canonicalRequest) {
# convert key into PKI format for signing, note this only accepts RSA, but
# that's what rsconnect generates already
pem <- openssl::write_pem(private_key)
pem_lines <- readLines(textConnection(pem))
pki_key <- PKI::PKI.load.key(pem_lines, format = "PEM")
# use sha1 digest and then sign. digest and PKI avoid using system openssl which
# can be problematic in strict FIPS environments
digested <- digest::digest(charToRaw(canonicalRequest), "sha1", serialize = FALSE, raw = TRUE)
rawsig <- PKI::PKI.sign(key = pki_key, digest = digested)
openssl::base64_encode(rawsig)
}
rfc2616Date <- function(time = Sys.time()) {
# set locale to POSIX/C to ensure ASCII date
old <- Sys.getlocale("LC_TIME")
Sys.setlocale("LC_TIME", "C")
defer(Sys.setlocale("LC_TIME", old))
strftime(time, "%a, %d %b %Y %H:%M:%S GMT", tz = "GMT")
}
# Helpers -----------------------------------------------------------------
userAgent <- function() {
paste("rsconnect", packageVersion("rsconnect"), sep = "/")
}
parseHttpHeader <- function(header) {
split <- strsplit(header, ": ")[[1]]
if (length(split) == 2) {
return(list(name = split[1], value = split[2]))
} else {
return(NULL)
}
}
parseHttpStatusCode <- function(statusLine) {
# extract status code; needs to deal with HTTP/1.0, HTTP/1.1, and HTTP/2
statusCode <- regexExtract("HTTP/[0-9]+\\.?[0-9]* ([0-9]+).*", statusLine)
if (is.null(statusCode)) {
return(-1)
} else {
return(as.integer(statusCode))
}
}
# @param request A list containing protocol, host, port, method, and path fields
# @param conn The connection to read the response from.
readHttpResponse <- function(request, conn) {
# read status code
resp <- readLines(conn, 1)
statusCode <- parseHttpStatusCode(resp[1])
# read response headers
contentLength <- NULL
contentType <- NULL
location <- NULL
setCookies <- NULL
repeat {
resp <- readLines(conn, 1)
if (nzchar(resp) == 0) {
break()
}
header <- parseHttpHeader(resp)
if (!is.null(header)) {
name <- tolower(header$name)
if (name == "content-type") {
contentType <- header$value
}
if (name == "content-length") {
contentLength <- as.integer(header$value)
}
if (name == "location") {
location <- header$value
}
if (name == "set-cookie") {
setCookies <- c(setCookies, header$value)
}
}
}
# Store the cookies that were found in the request
storeCookies(request, setCookies)
# read the response content
if (is.null(contentLength)) {
# content length is unknown, so stream remaining text
content <- paste(readLines(con = conn), collapse = "\n")
} else {
# we know the content length, so read exactly that many bytes
content <- rawToChar(readBin(
con = conn, what = "raw",
n = contentLength
))
}
# emit JSON trace if requested
if (httpTraceJson() && identical(contentType, "application/json")) {
cat(paste0(">> ", content, "\n"))
}
# return list
list(
req = request,
status = statusCode,
location = location,
contentType = contentType,
content = content
)
}
|