2 # basic amazon s3 operations
3 # Licensed under the terms of the GNU GPL v2
4 # Copyright 2007 Victor Lowther <victor.lowther@gmail.com>
8 # print a message and bail
14 # check to see if the variable name passed exists and holds a value.
17 [[ ${!1} ]] || die
"Environment variable ${1} is not set."
20 # check to see if we have all the needed S3 variables defined.
24 for x
in S3_ACCESS_KEY_ID S3_SECRET_ACCESS_KEY
; do
27 [[ -f ${S3_SECRET_ACCESS_KEY} ]] || die
"S3_SECRET_ACCESS_KEY must point to a file!"
28 sak
="$(wc -c "${S3_SECRET_ACCESS_KEY}")"
29 (( ${sak%%[!0-9 ]*} == 40 )) || \
30 die
"S3 Secret Access Key is not exactly 40 bytes long. Please fix it."
32 # check to see if our external dependencies exist
35 while [[ $# -ne 0 ]]; do
36 which "${1}" >& /dev/null || { res=1; echo "${1} not found."; }
39 (( res == 0 )) || die "aborting.
"
43 check_dep openssl date hmac cat grep curl
48 # $1 = string to url encode
50 # we don't urlencode everything, just enough stuff.
68 # accept input on stdin, put it on stdout.
69 # patches accepted to get more stuff
76 ## basic S3 functionality. x-amz-header functionality is not implemented.
77 # make an S3 signature string, which will be output on stdout.
78 s3_signature_string() {
80 # $2 = date string, must be in UTC
81 # $3 = bucket name, if any
82 # $4 = resource path, if any
83 # $5 = content md5, if any
84 # $6 = content MIME type, if any
85 # $7 = canonicalized headers, if any
86 # signature string will be output on stdout
87 local verr="Must pass a verb to s3_signature_string
!"
88 local verb="${1:?verr}"
91 local derr="Must pass a
date to s3_signature_string
!"
92 local date="${2:?derr}"
96 printf "%s
\n%s
\n%s
\n%s
\n%s
%s
%s
" \
97 "${verb}" "${md5}" "${mime}" "${date}" \
98 "${headers}" "${bucket}" "${resource}" | \
99 hmac sha1 "${S3_SECRET_ACCESS_KEY}" | openssl base64 -e -a
102 # cheesy, but it is the best way to have multiple headers.
104 # each arg passed will be output on its own line
107 echo "header
= \"${1}\""
113 # invoke curl to do all the heavy HTTP lifting
114 # $1 = method (one of GET, PUT, or DELETE. HEAD is not handled yet.)
115 # $2 = remote bucket.
118 local bucket remote date sig md5 arg inout headers
119 # header handling is kinda fugly, but it works.
120 bucket="${2:+/${2}}/" # slashify the bucket
121 remote="$
(urlenc
"${3}")" # if you don't, strange things may happen.
122 stdopts="--connect-timeout 10 --fail --silent"
123 [[ $CURL_S3_DEBUG == true ]] && stdopts="${stdopts} --show-error --fail"
125 GET) arg="-o" inout="${4:--}" # stdout if no $4
127 PUT) [[ ${2} ]] || die "PUT can has bucket?
"
128 if [[ ! ${3} ]]; then
130 headers[${#headers[@]}]="Content-Length
: 0"
131 elif [[ -f ${4} ]]; then
132 md5="$
(openssl dgst
-md5 -binary "${4}"|openssl base64
-e -a)"
133 arg="-T" inout="${4}"
134 headers[${#headers[@]}]="Expect
: 100-continue"
136 die "Cannot
write non-existing
file ${4}"
139 DELETE) arg="-X DELETE
"
142 *) die "Unknown verb
${1}. It probably would not have worked anyways.
" ;;
144 date="$
(TZ
=UTC
date '+%a, %e %b %Y %H:%M:%S %z')"
145 sig=$(s3_signature_string ${1} "${date}" "${bucket}" "${remote}" "${md5}")
147 headers
[${#headers[@]}]="Authorization: AWS ${S3_ACCESS_KEY_ID}:${sig}"
148 headers[${#headers[@]}]="Date
: ${date}"
149 [[ ${md5} ]] && headers[${#headers[@]}]="Content-MD5: ${md5}"
150 curl
${arg} "${inout}" ${stdopts} -K <(curl_headers "${headers[@]}") \
151 "http
://s3.amazonaws.com
${bucket}${remote}"
156 # $1 = remote bucket to put it into
157 # $2 = remote name to put
158 # $3 = file to put. This must be present if $2 is.
159 s3_curl PUT "${1}" "${2}" "${3:-${2}}"
164 # $1 = bucket to get file from
165 # $2 = remote file to get
166 # $3 = local file to get into. Will be overwritten if it exists.
167 # If this contains a path, that path must exist before calling this.
168 s3_curl GET "${1}" "${2}" "${3:-${2}}"
173 # same args as s3_get, but uses the HEAD verb instead of the GET verb.
174 s3_curl HEAD "${1}" "${2}" >/dev/null
178 # Hideously ugly, but it works well enough.
180 s3_get |grep -o '<Name>[^>]*</Name>' |sed 's/<[^>]*>//g' |xmldec
184 # this will only return the first thousand entries, alas
185 # Mabye some kind soul can fix this without writing an XML parser in bash?
186 # Also need to add xml entity handling.
188 # $1 = bucket to list
189 [ "x
${1}" == "x
" ] && return 1
190 s3_get "${1}" |grep -o '<Key>[^>]*</Key>' |sed 's/<[^>]*>//g'| xmldec
195 # $1 = bucket to delete from
196 # $2 = item to delete
197 s3_curl DELETE "${1}" "${2}"
201 # because this uses s3_list, it suffers from the same flaws.
203 # $1 = bucket to delete everything from
204 s3_list "${1}" | while read f; do
205 s3_delete "${1}" "${f}";
211 put) shift; s3_put "$@
" ;;
212 get) shift; s3_get "$@
" ;;
213 rm) shift; s3_delete "$@
" ;;
214 ls) shift; s3_list "$@
" ;;
215 test) shift; s3_test "$@
" ;;
216 buckets) s3_buckets ;;
217 rmrf) shift; s3_rmrf "$@
" ;;
218 *) die "Unknown
command ${1}.
"