You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
3.4 KiB
C
117 lines
3.4 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* All rights reserved. *
|
|
* *
|
|
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
|
* terms governing use, modification, and redistribution, is contained in *
|
|
* the COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Read-Only S3 Virtual File Driver (VFD)
|
|
*
|
|
* Programmer: John Mainzer
|
|
* 2017-10-10
|
|
*
|
|
* Purpose: The public header file for the ros3 driver.
|
|
*/
|
|
#ifndef H5FDros3_H
|
|
#define H5FDros3_H
|
|
|
|
#ifdef H5_HAVE_ROS3_VFD
|
|
#define H5FD_ROS3 (H5FDperform_init(H5FD_ros3_init))
|
|
#define H5FD_ROS3_VALUE H5_VFD_ROS3
|
|
#else
|
|
#define H5FD_ROS3 (H5I_INVALID_HID)
|
|
#define H5FD_ROS3_VALUE H5_VFD_INVALID
|
|
#endif /* H5_HAVE_ROS3_VFD */
|
|
|
|
#ifdef H5_HAVE_ROS3_VFD
|
|
|
|
/****************************************************************************
|
|
*
|
|
* Structure: H5FD_ros3_fapl_t
|
|
*
|
|
* Purpose:
|
|
*
|
|
* H5FD_ros3_fapl_t is a public structure that is used to pass S3
|
|
* authentication data to the appropriate S3 VFD via the FAPL. A pointer
|
|
* to an instance of this structure is a parameter to H5Pset_fapl_ros3()
|
|
* and H5Pget_fapl_ros3().
|
|
*
|
|
*
|
|
*
|
|
* `version` (int32_t)
|
|
*
|
|
* Version number of the H5FD_ros3_fapl_t structure. Any instance passed
|
|
* to the above calls must have a recognized version number, or an error
|
|
* will be flagged.
|
|
*
|
|
* This field should be set to H5FD_CURR_ROS3_FAPL_T_VERSION.
|
|
*
|
|
* `authenticate` (hbool_t)
|
|
*
|
|
* Flag TRUE or FALSE whether or not requests are to be authenticated
|
|
* with the AWS4 algorithm.
|
|
* If TRUE, `aws_region`, `secret_id`, and `secret_key` must be populated.
|
|
* If FALSE, those three components are unused.
|
|
*
|
|
* `aws_region` (char[])
|
|
*
|
|
* String: name of the AWS "region" of the host, e.g. "us-east-1".
|
|
*
|
|
* `secret_id` (char[])
|
|
*
|
|
* String: "Access ID" for the resource.
|
|
*
|
|
* `secret_key` (char[])
|
|
*
|
|
* String: "Secret Access Key" associated with the ID and resource.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#define H5FD_CURR_ROS3_FAPL_T_VERSION 1
|
|
|
|
#define H5FD_ROS3_MAX_REGION_LEN 32
|
|
#define H5FD_ROS3_MAX_SECRET_ID_LEN 128
|
|
#define H5FD_ROS3_MAX_SECRET_KEY_LEN 128
|
|
|
|
typedef struct H5FD_ros3_fapl_t {
|
|
int32_t version;
|
|
hbool_t authenticate;
|
|
char aws_region[H5FD_ROS3_MAX_REGION_LEN + 1];
|
|
char secret_id[H5FD_ROS3_MAX_SECRET_ID_LEN + 1];
|
|
char secret_key[H5FD_ROS3_MAX_SECRET_KEY_LEN + 1];
|
|
} H5FD_ros3_fapl_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
H5_DLL hid_t H5FD_ros3_init(void);
|
|
|
|
/**
|
|
* \ingroup FAPL
|
|
*
|
|
* \todo Add missing documentation
|
|
*/
|
|
H5_DLL herr_t H5Pget_fapl_ros3(hid_t fapl_id, H5FD_ros3_fapl_t *fa_out);
|
|
|
|
/**
|
|
* \ingroup FAPL
|
|
*
|
|
* \todo Add missing documentation
|
|
*/
|
|
H5_DLL herr_t H5Pset_fapl_ros3(hid_t fapl_id, const H5FD_ros3_fapl_t *fa);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* H5_HAVE_ROS3_VFD */
|
|
|
|
#endif /* ifndef H5FDros3_H */
|