git.gag.com Git - debian/amanda/blob - device-src/s3.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Zmanda, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 as published
   6  * by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  10  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16  *
  17  * Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
  18  * Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
  19  */
  20
  21 #ifndef __S3_H__
  22 #define __S3_H__
  23 #include <glib.h>
  24 #include <curl/curl.h>
  25
  26 /*
  27  * Data types
  28  */
  29
  30 /* An opaque handle.  S3Handles should only be accessed from a single
  31  * thread at any given time, although it is fine to use different handles
  32  * in different threads simultaneously. */
  33 typedef struct S3Handle S3Handle;
  34
  35 /* Callback function to read data to upload
  36  *
  37  * @note this is the same as CURLOPT_READFUNCTION
  38  *
  39  * @param data: The pointer to write data to
  40  * @param size: The size of each "element" of the data buffer in bytes
  41  * @param nmemb: The number of elements in the data buffer.
  42  * So, the buffer's size is size*nmemb bytes.
  43  * @param stream: The read_data (an opaque pointer)
  44  *
  45  * @return The number of bytes written to the buffer,
  46  * CURL_READFUNC_PAUSE to pause, or CURL_READFUNC_ABORT to abort.
  47  * Return 0 only if there's no more data to be uploaded.
  48  */
  49 typedef size_t (*s3_read_func)(void *data, size_t size, size_t nmemb, void *stream);
  50
  51 /* This function is called to get size of the upload data
  52  *
  53  * @param data: The write_data (opaque pointer)
  54  *
  55  * @return The number of bytes of data, negative for error
  56  */
  57 typedef size_t (*s3_size_func)(void *data);
  58
  59 /* This function is called to get MD5 hash of the upload data
  60  *
  61  * @param data: The write_data (opaque pointer)
  62  *
  63  * @return The MD5 hash, NULL on error
  64  */
  65 typedef GByteArray* (*s3_md5_func)(void *data);
  66
  67 /* This function is called to reset an upload or download data stream
  68  * to the beginning
  69  *
  70  * @param data: The read_data or write_data (opaque pointer)
  71  *
  72  * @return The number of bytes of data, negative for error
  73  */
  74 typedef void (*s3_reset_func)(void *data);
  75
  76 /* Callback function to write data that's been downloaded
  77  *
  78  * @note this is the same as CURLOPT_WRITEFUNCTION
  79  *
  80  * @param data: The pointer to read data from
  81  * @param size: The size of each "element" of the data buffer in bytes
  82  * @param nmemb: The number of elements in the data buffer.
  83  * So, the buffer's size is size*nmemb bytes.
  84  * @param stream: the write_data (an opaque pointer)
  85  *
  86  * @return The number of bytes written to the buffer or
  87  * CURL_WRITEFUNC_PAUSE to pause.
  88  * If it's the number of bytes written, it should match the buffer size
  89  */
  90 typedef size_t (*s3_write_func)(void *data, size_t size, size_t nmemb, void *stream);
  91
  92 /**
  93  * Callback function to track progress
  94  *
  95  * @note this is the same as CURLOPT_PROGRESSFUNCTION
  96  *
  97  * @param data: The progress_data
  98  * @param dltotal: The total number of bytes to downloaded
  99  * @param dlnow: The current number of bytes downloaded
 100  * @param ultotal: The total number of bytes to downloaded
 101  * @param ulnow: The current number of bytes downloaded
 102  *
 103  * @return 0 to continue, non-zero to abort.
 104  */
 105 typedef curl_progress_callback s3_progress_func;
 106
 107 /*
 108  * Constants
 109  */
 110
 111 /* These are assumed to be already URL-escaped. */
 112 # define STS_BASE_URL "https://ls.amazonaws.com/"
 113 # define STS_PRODUCT_TOKEN "{ProductToken}AAAGQXBwVGtu4geoGybuwuk8VEEPzJ9ZANpu0yzbf9g4Gs5Iarzff9B7qaDBEEaWcAzWpcN7zmdMO765jOtEFc4DWTRNkpPSzUnTdkHbdYUamath73OreaZtB86jy/JF0gsHZfhxeKc/3aLr8HNT//DsX3r272zYHLDPWWUbFguOwqNjllnt6BshYREx59l8RrWABLSa37dyJeN+faGvz3uQxiDakZRn3LfInOE6d9+fTFl50LPoP08LCqI/SJfpouzWix7D/cep3Jq8yYNyM1rgAOTF7/wh7r8OuPDLJ/xZUDLfykePIAM="
 114
 115 /* This preprocessor magic will enumerate constants named S3_ERROR_XxxYyy for
 116  * each of the errors in parentheses.
 117  *
 118  * see http://docs.amazonwebservices.com/AmazonS3/2006-03-01/ErrorCodeList.html
 119  * for Amazon's breakdown of error responses.
 120  */
 121 #define S3_ERROR_LIST \
 122     S3_ERROR(None), \
 123     S3_ERROR(AccountProblem), \
 124     S3_ERROR(AllAccessDisabled), \
 125     S3_ERROR(AmbiguousGrantByEmailAddress), \
 126     S3_ERROR(OperationAborted), \
 127     S3_ERROR(BadDigest), \
 128     S3_ERROR(BucketAlreadyExists), \
 129     S3_ERROR(BucketAlreadyOwnedByYou), \
 130     S3_ERROR(BucketNotEmpty), \
 131     S3_ERROR(CredentialsNotSupported), \
 132     S3_ERROR(EntityTooLarge), \
 133     S3_ERROR(IncompleteBody), \
 134     S3_ERROR(InternalError), \
 135     S3_ERROR(InvalidAccessKeyId), \
 136     S3_ERROR(InvalidArgument), \
 137     S3_ERROR(InvalidBucketName), \
 138     S3_ERROR(InvalidDigest), \
 139     S3_ERROR(InvalidRange), \
 140     S3_ERROR(InvalidSecurity), \
 141     S3_ERROR(InvalidSOAPRequest), \
 142     S3_ERROR(InvalidStorageClass), \
 143     S3_ERROR(InvalidTargetBucketForLogging), \
 144     S3_ERROR(KeyTooLong), \
 145     S3_ERROR(InvalidURI), \
 146     S3_ERROR(MalformedACLError), \
 147     S3_ERROR(MaxMessageLengthExceeded), \
 148     S3_ERROR(MetadataTooLarge), \
 149     S3_ERROR(MethodNotAllowed), \
 150     S3_ERROR(MissingAttachment), \
 151     S3_ERROR(MissingContentLength), \
 152     S3_ERROR(MissingSecurityElement), \
 153     S3_ERROR(MissingSecurityHeader), \
 154     S3_ERROR(NoLoggingStatusForKey), \
 155     S3_ERROR(NoSuchBucket), \
 156     S3_ERROR(NoSuchEntity), \
 157     S3_ERROR(NoSuchKey), \
 158     S3_ERROR(NotImplemented), \
 159     S3_ERROR(NotSignedUp), \
 160     S3_ERROR(PreconditionFailed), \
 161     S3_ERROR(RequestTimeout), \
 162     S3_ERROR(RequestTimeTooSkewed), \
 163     S3_ERROR(RequestTorrentOfBucketError), \
 164     S3_ERROR(SignatureDoesNotMatch), \
 165     S3_ERROR(TooManyBuckets), \
 166     S3_ERROR(UnexpectedContent), \
 167     S3_ERROR(UnresolvableGrantByEmailAddress), \
 168     S3_ERROR(Unknown), \
 169     S3_ERROR(END)
 170
 171 typedef enum {
 172 #define S3_ERROR(NAME) S3_ERROR_ ## NAME
 173     S3_ERROR_LIST
 174 #undef S3_ERROR
 175 } s3_error_code_t;
 176
 177 /*
 178  * Functions
 179  */
 180
 181 /* Does this install of curl support SSL?
 182  *
 183  * @returns: boolean
 184  */
 185 gboolean
 186 s3_curl_supports_ssl(void);
 187
 188 /* Checks if the version of libcurl being used supports and checks
 189  * wildcard certificates correctly (used for the subdomains required
 190  * by location constraints).
 191  *
 192  * @returns: true if the version of libcurl is new enough
 193  */
 194 gboolean
 195 s3_curl_location_compat(void);
 196
 197 /* Checks if a bucket name is compatible with setting a location
 198  * constraint.
 199  *
 200  * @note This doesn't guarantee that bucket name is entirely valid,
 201  * just that using it as one (or more) subdomain(s) of s3.amazonaws.com
 202  * won't fail; that would prevent the reporting of useful messages from
 203  * the service.
 204  *
 205  * @param bucket: the bucket name
 206  * @returns: true if the bucket name is compatible
 207  */
 208 gboolean
 209 s3_bucket_location_compat(const char *bucket);
 210
 211 /* Initialize S3 operation
 212  *
 213  * If an error occurs in this function, diagnostic information is
 214  * printed to stderr.
 215  *
 216  * @returns: false if an error occurred
 217  */
 218 gboolean
 219 s3_init(void);
 220
 221 /* Set up an S3Handle.
 222  *
 223  * The concept of a bucket is defined by the Amazon S3 API.
 224  * See: "Components of Amazon S3" - API Version 2006-03-01 pg. 8
 225  *
 226  * @param access_key: the secret key for Amazon Web Services
 227  * @param secret_key: the secret key for Amazon Web Services
 228  * @param user_token: the user token for Amazon DevPay
 229  * @param bucket_location: the location constraint for buckets
 230  * @param storage_class: the storage class for new objects
 231  * @param ca_info: the path to pass to libcurl as the certificate authority.
 232  *                 see curl_easy_setopt() CURLOPT_CAINFO for more
 233  * @returns: the new S3Handle
 234  */
 235 S3Handle *
 236 s3_open(const char * access_key, const char *secret_key, const char *host,
 237         const char *service_path, gboolean use_subdomain,
 238         const char * user_token,
 239         const char * bucket_location, const char * storage_class, const char * ca_info);
 240
 241 /* Deallocate an S3Handle
 242  *
 243  * @param hdl: the S3Handle object
 244  */
 245 void
 246 s3_free(S3Handle *hdl);
 247
 248 /* Reset the information about the last request, including
 249  * freeing any allocated memory.  The S3Handle itself is not
 250  * freed and may be used again.  This function is called
 251  * automatically as needed, and should be called to free memory
 252  * when the handle will not be used for some time.
 253  *
 254  * @param hdl: the S3Handle object
 255  */
 256 void
 257 s3_reset(S3Handle *hdl);
 258
 259 /* Get the error information for the last operation
 260  *
 261  * All results are returned via result parameters.  If any parameter is
 262  * NULL, that result will not be returned.  Caller is not responsible for
 263  * freeing any returned strings, although the results are only valid until
 264  * the next call to an S3 function with this handle.
 265  *
 266  * @param hdl: the S3Handle object
 267  * @param message: (result) the error message, or NULL if none exists
 268  * @param response_code: (result) the HTTP response code (or 0 if none exists)
 269  * @param s3_error_code: (result) the S3 error code (see constants, above)
 270  * @param s3_error_name: (result) the S3 error name (e.g., "RequestTimeout"),
 271  * or NULL if none exists
 272  * @param curl_code: (result) the curl error code (or 0 if none exists)
 273  * @param num_retries: (result) number of retries
 274  */
 275 void
 276 s3_error(S3Handle *hdl,
 277          const char **message,
 278          guint *response_code,
 279          s3_error_code_t *s3_error_code,
 280          const char **s3_error_name,
 281          CURLcode *curl_code,
 282          guint *num_retries);
 283
 284 /* Control verbose output of HTTP transactions, etc.
 285  *
 286  * @param hdl: the S3Handle object
 287  * @param verbose: if true, send HTTP transactions, etc. to debug output
 288  */
 289 void
 290 s3_verbose(S3Handle *hdl,
 291        gboolean verbose);
 292
 293 /* Control the use of SSL with HTTP transactions.
 294  *
 295  * @param hdl: the S3Handle object
 296  * @param use_ssl: if true, use SSL (if curl supports it)
 297  * @returns: true if the setting is valid
 298  */
 299 gboolean
 300 s3_use_ssl(S3Handle *hdl, gboolean use_ssl);
 301
 302 /* Control the throttling of S3 uploads.  Only supported with curl >= 7.15.5.
 303  *
 304  * @param hdl: the S3Handle object
 305  * @param max_send_speed: max speed (bytes/sec) at which to send
 306  * @returns: true if the setting is valid
 307  */
 308 gboolean
 309 s3_set_max_send_speed(S3Handle *hdl, guint64 max_send_speed);
 310
 311 /* Control the throttling of S3 downloads.  Only supported with curl >= 7.15.5.
 312  *
 313  * @param hdl: the S3Handle object
 314  * @param max_recv_speed: max speed (bytes/sec) at which to receive
 315  * @returns: true if the setting is valid
 316  */
 317 gboolean
 318 s3_set_max_recv_speed(S3Handle *hdl, guint64 max_recv_speed);
 319
 320 /* Get the error information from the last operation on this handle,
 321  * formatted as a string.
 322  *
 323  * Caller is responsible for freeing the resulting string.
 324  *
 325  * @param hdl: the S3Handle object
 326  * @returns: string, or NULL if no error occurred
 327  */
 328 char *
 329 s3_strerror(S3Handle *hdl);
 330
 331 /* Perform an upload.
 332  *
 333  * When this function returns, KEY and BUFFER remain the
 334  * responsibility of the caller.
 335  *
 336  * @param hdl: the S3Handle object
 337  * @param bucket: the bucket to which the upload should be made
 338  * @param key: the key to which the upload should be made
 339  * @param read_func: the callback for reading data
 340  * @param reset_func: the callback for to reset reading data
 341  * @param size_func: the callback to get the number of bytes to upload
 342  * @param md5_func: the callback to get the MD5 hash of the data to upload
 343  * @param read_data: pointer to pass to the above functions
 344  * @param progress_func: the callback for progress information
 345  * @param progress_data: pointer to pass to C{progress_func}
 346  *
 347  * @returns: false if an error ocurred
 348  */
 349 gboolean
 350 s3_upload(S3Handle *hdl,
 351           const char *bucket,
 352           const char *key,
 353           s3_read_func read_func,
 354           s3_reset_func reset_func,
 355           s3_size_func size_func,
 356           s3_md5_func md5_func,
 357           gpointer read_data,
 358           s3_progress_func progress_func,
 359           gpointer progress_data);
 360
 361 /* List all of the files matching the pseudo-glob C{PREFIX*DELIMITER*},
 362  * returning only that portion which matches C{PREFIX*DELIMITER}.  S3 supports
 363  * this particular semantics, making it quite efficient.  The returned list
 364  * should be freed by the caller.
 365  *
 366  * @param hdl: the S3Handle object
 367  * @param bucket: the bucket to list
 368  * @param prefix: the prefix
 369  * @param delimiter: delimiter (any length string)
 370  * @param list: (output) the list of files
 371  * @param total_size: (output) sum of size of files
 372  * @returns: FALSE if an error occurs
 373  */
 374 gboolean
 375 s3_list_keys(S3Handle *hdl,
 376               const char *bucket,
 377               const char *prefix,
 378               const char *delimiter,
 379               GSList **list,
 380               guint64 *total_size);
 381
 382 /* Read an entire file, passing the contents to write_func buffer
 383  * by buffer.
 384  *
 385  * @param hdl: the S3Handle object
 386  * @param bucket: the bucket to read from
 387  * @param key: the key to read from
 388  * @param write_func: the callback for writing data
 389  * @param reset_func: the callback for to reset writing data
 390  * @param write_data: pointer to pass to C{write_func}
 391  * @param progress_func: the callback for progress information
 392  * @param progress_data: pointer to pass to C{progress_func}
 393  * @returns: FALSE if an error occurs
 394  */
 395 gboolean
 396 s3_read(S3Handle *hdl,
 397         const char *bucket,
 398         const char *key,
 399         s3_write_func write_func,
 400         s3_reset_func reset_func,
 401         gpointer write_data,
 402         s3_progress_func progress_func,
 403         gpointer progress_data);
 404
 405 /* Delete a file.
 406  *
 407  * @param hdl: the S3Handle object
 408  * @param bucket: the bucket to delete from
 409  * @param key: the key to delete
 410  * @returns: FALSE if an error occurs; a non-existent file is I{not} considered an error.
 411  */
 412 gboolean
 413 s3_delete(S3Handle *hdl,
 414           const char *bucket,
 415           const char *key);
 416
 417 /* Create a bucket.
 418  *
 419  * @param hdl: the S3Handle object
 420  * @param bucket: the bucket to create
 421  * @returns: FALSE if an error occurs
 422  */
 423 gboolean
 424 s3_make_bucket(S3Handle *hdl,
 425                const char *bucket);
 426
 427 /* Delete a bucket
 428  *
 429  * @note A bucket can not be deleted if it still contains keys
 430  *
 431  * @param hdl: the S3Handle object
 432  * @param bucket: the bucket to delete
 433  * @returns: FALSE if an error occurs
 434  */
 435 gboolean
 436 s3_delete_bucket(S3Handle *hdl,
 437                  const char *bucket);
 438
 439 /* Attempt a RefreshAWSSecurityToken on a token; if it succeeds, the old
 440  * token will be freed and replaced by the new. If it fails, the old
 441  * token is left unchanged and FALSE is returned. */
 442 gboolean sts_refresh_token(char ** token, const char * directory);
 443
 444 /* These functions are for if you want to use curl on your own. You get more
 445  * control, but it's a lot of work that way: */
 446 typedef struct {
 447     char *buffer;
 448     guint buffer_len;
 449     guint buffer_pos;
 450     guint max_buffer_size;
 451 } CurlBuffer;
 452
 453 #define S3_BUFFER_READ_FUNCS s3_buffer_read_func, s3_buffer_reset_func, s3_buffer_size_func, s3_buffer_md5_func
 454
 455 #define S3_BUFFER_WRITE_FUNCS s3_buffer_write_func, s3_buffer_reset_func
 456
 457 /* a CURLOPT_READFUNCTION to read data from a buffer. */
 458 size_t
 459 s3_buffer_read_func(void *ptr, size_t size, size_t nmemb, void * stream);
 460
 461 size_t
 462 s3_buffer_size_func(void *stream);
 463
 464 GByteArray*
 465 s3_buffer_md5_func(void *stream);
 466
 467 void
 468 s3_buffer_reset_func(void *stream);
 469
 470 #define S3_EMPTY_READ_FUNCS s3_empty_read_func, NULL, s3_empty_size_func, s3_empty_md5_func
 471
 472 /* a CURLOPT_WRITEFUNCTION to write data to a buffer. */
 473 size_t
 474 s3_buffer_write_func(void *ptr, size_t size, size_t nmemb, void *stream);
 475
 476 /* a CURLOPT_READFUNCTION that writes nothing. */
 477 size_t
 478 s3_empty_read_func(void *ptr, size_t size, size_t nmemb, void * stream);
 479
 480 size_t
 481 s3_empty_size_func(void *stream);
 482
 483 GByteArray*
 484 s3_empty_md5_func(void *stream);
 485
 486 #define S3_COUNTER_WRITE_FUNCS s3_counter_write_func, s3_counter_reset_func
 487
 488 /* a CURLOPT_WRITEFUNCTION to write data that just counts data.
 489  * s3_write_data should be NULL or a pointer to an gint64.
 490  */
 491 size_t
 492 s3_counter_write_func(void *ptr, size_t size, size_t nmemb, void *stream);
 493
 494 void
 495 s3_counter_reset_func(void *stream);
 496
 497 #ifdef _WIN32
 498 /* a CURLOPT_READFUNCTION to read data from a file. */
 499 size_t
 500 s3_file_read_func(void *ptr, size_t size, size_t nmemb, void * stream);
 501
 502 size_t
 503 s3_file_size_func(void *stream);
 504
 505 GByteArray*
 506 s3_file_md5_func(void *stream);
 507
 508 size_t
 509 s3_file_reset_func(void *stream);
 510
 511 /* a CURLOPT_WRITEFUNCTION to write data to a file. */
 512 size_t
 513 s3_file_write_func(void *ptr, size_t size, size_t nmemb, void *stream);
 514 #endif
 515
 516 /* Adds a null termination to a buffer. */
 517 void terminate_buffer(CurlBuffer *);
 518
 519 #endif