awscred_func.h

/*
 * s3fs-fuse-awscred-lib ( s3fs-fuse credential I/F library for AWS )
 *
 *     Copyright 2022 Takeshi Nakatani <ggtakec@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef AWSCRED_FUNC_H_
#define AWSCRED_FUNC_H_

//-------------------------------------------------------------------
// [NOTE] About this file and functions
//-------------------------------------------------------------------
// This file is a function definition copied from s3fs_extcred.h in
// s3fs-fuse. This library externs the following functions and is
// loaded with s3fs-fuse.
//

//-------------------------------------------------------------------
// Attributes(weak) : use only in s3fs-fuse internally
//-------------------------------------------------------------------
// [NOTE]
// This macro is only used inside s3fs-fuse.
// External projects that utilize this header file substitute empty
//values as follows:
//
#ifndef	S3FS_FUNCATTR_WEAK
#define	S3FS_FUNCATTR_WEAK
#endif

extern "C" {
//-------------------------------------------------------------------
// Prototype for External Credential 4 functions
//-------------------------------------------------------------------
//
// [Required] VersionS3fsCredential
//
// Returns the library name and version as a string.
//
extern const char* VersionS3fsCredential(bool detail) S3FS_FUNCATTR_WEAK;

//
// [Optional] InitS3fsCredential
//
// A function that does the necessary initialization after the library is
// loaded. This function is called only once immediately after loading the
// library.
// If there is a required initialization inside the library, implement it.
// Implementation of this function is optional and not required. If not
// implemented, it will not be called.
//
// const char* popts : String passed with the credlib_opts option. If the
//                     credlib_opts option is not specified, NULL will be
//                     passed.
// char** pperrstr   : pperrstr is used to pass the error message to the
//                     caller when an error occurs.
//                     If this pointer is not NULL, you can allocate memory
//                     and set an error message to it. The allocated memory
//                     area is freed by the caller.
//
extern bool InitS3fsCredential(const char* popts, char** pperrstr) S3FS_FUNCATTR_WEAK;

//
// [Optional] FreeS3fsCredential
//
// A function that is called only once just before the library is unloaded.
// If there is a required discard process in the library, implement it.
// Implementation of this feature is optional and not required.
// If not implemented, it will not be called.
//
// char** pperrstr : pperrstr is used to pass the error message to the
//                   caller when an error occurs.
//                   If this pointer is not NULL, you can allocate memory
//                   and set an error message to it. The allocated memory
//                   area is freed by the caller.
//
extern bool FreeS3fsCredential(char** pperrstr) S3FS_FUNCATTR_WEAK;

//
// [Required] UpdateS3fsCredential
//
// A function that updates the token.
//
// char** ppaccess_key_id     : Allocate and set "Access Key ID" string
//                              area to *ppaccess_key_id.
// char** ppserect_access_key : Allocate and set "Access Secret Key ID"
//                              string area to *ppserect_access_key.
// char** ppaccess_token      : Allocate and set "Token" string area to
//                              *ppaccess_token.
// long long* ptoken_expire   : Set token expire time(time_t) value to
//                              *ptoken_expire.
//                              This is essentially a time_t* variable.
//                              To avoid system differences about time_t
//                              size, long long* is used.
//                              When setting the value, cast from time_t
//                              to long long to set the value.
// char** pperrstr            : pperrstr is used to pass the error message to the
//                              caller when an error occurs.
//
// For all argument of the character string pointer(char **) set the
// allocated string area. The allocated area is freed by the caller.
//
extern bool UpdateS3fsCredential(char** ppaccess_key_id, char** ppserect_access_key, char** ppaccess_token, long long* ptoken_expire, char** pperrstr) S3FS_FUNCATTR_WEAK;

}		// extern "C"

#endif // AWSCRED_FUNC_H_

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noexpandtab sw=4 ts=4 fdm=marker
 * vim<600: noexpandtab sw=4 ts=4
 */