mirror of
https://github.com/Unidata/netcdf-c.git
synced 2025-02-05 16:20:10 +08:00
6b69b9c52c
## S3 Related Fixes * Add comprehensive support for specifying AWS profiles to provide access credentials. * Parse the files "~/.aws/config" and "~/.aws/credentials to provide credentials for the HDF5 ROS3 driver and to locate default region. * Add a function to obtain the currently active S3 credentials. The search rules are defined in docs/nczarr.md. * Provide documentation for the new features. * Modify the struct NCauth (in include/ncauth.h) to replace specific S3 credentials with a profile name. * Add a unit test to test the operation of profile and credentials management. * Add support for URLS of the form "s3://<bucket>/<key>"; this requires obtaining a default region. * Allows the specification of profile and/or region in a URL of the form "#mode=nczarr,...&aws.region=...&aws.profile=..." ## Misc. Fixes * Move the ezxml code to libdispatch so that it can be used both by DAP4 and nczarr. * Modify nclist to provide a deep clone operation. * Modify ncuri to provide a deep clone operation. * Modify the .rc file format to allow the specification of a path to be tested when looking for an entry in the .rc file. * Ensure that the NC_rcload function is called. * Modify nchttp to support setting request headers.
113 lines
3.5 KiB
C
113 lines
3.5 KiB
C
/*
|
|
Copyright (c) 1998-2018 University Corporation for Atmospheric Research/Unidata
|
|
See COPYRIGHT for license information.
|
|
*/
|
|
|
|
/*
|
|
Common functionality for reading
|
|
and accessing rc files (e.g. .daprc).
|
|
*/
|
|
|
|
#ifndef NCRC_H
|
|
#define NCRC_H
|
|
|
|
/* Need these support includes */
|
|
#include "ncuri.h"
|
|
#include "nclist.h"
|
|
#include "ncbytes.h"
|
|
|
|
/* getenv() keys */
|
|
#define NCRCENVIGNORE "NCRCENV_IGNORE"
|
|
#define NCRCENVRC "NCRCENV_RC"
|
|
|
|
/* Known .aws profile keys */
|
|
#define AWS_ACCESS_KEY_ID "aws_access_key_id"
|
|
#define AWS_SECRET_ACCESS_KEY "aws_secret_access_key"
|
|
#define AWS_REGION "aws_region"
|
|
|
|
typedef struct NCRCentry {
|
|
char* host; /* combined host:port */
|
|
char* path; /* prefix to match or NULL */
|
|
char* key;
|
|
char* value;
|
|
} NCRCentry;
|
|
|
|
/* collect all the relevant info around the rc file */
|
|
typedef struct NCRCinfo {
|
|
int ignore; /* if 1, then do not use any rc file */
|
|
int loaded; /* 1 => already loaded */
|
|
NClist* entries; /* the rc file entry store fields*/
|
|
char* rcfile; /* specified rcfile; overrides anything else */
|
|
} NCRCinfo;
|
|
|
|
/* Collect global state info in one place */
|
|
typedef struct NCRCglobalstate {
|
|
int initialized;
|
|
char* tempdir; /* track a usable temp dir */
|
|
char* home; /* track $HOME */
|
|
char* cwd; /* track getcwd */
|
|
NCRCinfo rcinfo; /* Currently only one rc file per session */
|
|
struct GlobalZarr { /* Zarr specific parameters */
|
|
char dimension_separator;
|
|
} zarr;
|
|
struct S3credentials {
|
|
NClist* profiles; /* NClist<struct AWSprofile*> */
|
|
} s3creds;
|
|
} NCRCglobalstate;
|
|
|
|
struct AWSprofile {
|
|
char* name;
|
|
NClist* entries; /* NClist<struct AWSentry*> */
|
|
};
|
|
|
|
struct AWSentry {
|
|
char* key;
|
|
char* value;
|
|
};
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* From drc.c */
|
|
EXTERNL int ncrc_createglobalstate(void);
|
|
EXTERNL void ncrc_initialize(void);
|
|
EXTERNL void ncrc_freeglobalstate(void);
|
|
EXTERNL int NC_rcfile_insert(const char* key, const char* value, const char* hostport, const char* path);
|
|
EXTERNL char* NC_rclookup(const char* key, const char* hostport, const char* path);
|
|
EXTERNL char* NC_rclookupx(NCURI* uri, const char* key);
|
|
|
|
/* Following are primarily for debugging */
|
|
/* Obtain the count of number of entries */
|
|
EXTERNL size_t NC_rcfile_length(NCRCinfo*);
|
|
/* Obtain the ith entry; return NULL if out of range */
|
|
EXTERNL NCRCentry* NC_rcfile_ith(NCRCinfo*,size_t);
|
|
|
|
/* For internal use */
|
|
EXTERNL NCRCglobalstate* ncrc_getglobalstate(void);
|
|
EXTERNL void NC_rcclear(NCRCinfo* info);
|
|
EXTERNL void NC_rcclear(NCRCinfo* info);
|
|
|
|
/* From dutil.c (Might later move to e.g. nc.h */
|
|
EXTERNL int NC__testurl(const char* path, char** basenamep);
|
|
EXTERNL int NC_isLittleEndian(void);
|
|
EXTERNL char* NC_entityescape(const char* s);
|
|
EXTERNL int NC_readfile(const char* filename, NCbytes* content);
|
|
EXTERNL int NC_writefile(const char* filename, size_t size, void* content);
|
|
EXTERNL char* NC_mktmp(const char* base);
|
|
EXTERNL int NC_getmodelist(const char* url, NClist** modelistp);
|
|
EXTERNL int NC_testmode(const char* path, const char* tag);
|
|
EXTERNL int NC_split_delim(const char* path, char delim, NClist* segments);
|
|
EXTERNL int NC_s3urlrebuild(NCURI* url, NCURI** newurlp, char** bucketp, char** regionp);
|
|
EXTERNL int NC_getactives3profile(NCURI* uri, const char** profilep);
|
|
EXTERNL int NC_getdefaults3region(NCURI* uri, const char** regionp);
|
|
/* S3 profiles */
|
|
EXTERNL int NC_authgets3profile(const char* profile, struct AWSprofile** profilep);
|
|
EXTERNL int NC_s3profilelookup(const char* profile, const char* key, const char** valuep);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /*NCRC_H*/
|