BPSecLib_Public.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 The Johns Hopkins University Applied Physics
 * Laboratory LLC.
 *
 * This file is part of the Bundle Protocol Security Library (BSL).
 *
 * 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.
 *
 * This work was performed for the Jet Propulsion Laboratory, California
 * Institute of Technology, sponsored by the United States Government under
 * the prime contract 80NM0018D0004 between the Caltech and NASA under
 * subcontract 1700763.
 */
 
#ifndef BSL_BPSECLIB_PUBLIC_H_
#define BSL_BPSECLIB_PUBLIC_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#if defined(__GNUC__) || defined(__clang__)
#define BSL_REQUIRE_CHECK __attribute__((warn_unused_result))
#else
#define BSL_REQUIRE_CHECK
#endif
 
typedef struct BSL_LibCtx_s BSL_LibCtx_t;
 
typedef struct BSL_SecurityResponseSet_s BSL_SecurityResponseSet_t;
 
typedef struct BSL_SecurityActionSet_s BSL_SecurityActionSet_t;
 
typedef struct BSL_SecCtxDesc_s BSL_SecCtxDesc_t;
 
typedef struct BSL_PolicyDesc_s BSL_PolicyDesc_t;
 
#define BSL_DEFAULT_STRLEN (128)
typedef char BSL_StaticString_t[BSL_DEFAULT_STRLEN];
 
typedef enum
{
    BSL_POLICYLOCATION_APPIN = 101,
    BSL_POLICYLOCATION_APPOUT,
    BSL_POLICYLOCATION_CLIN,
    BSL_POLICYLOCATION_CLOUT
} BSL_PolicyLocation_e;
 
typedef enum
{
    BSL_BUNDLECRCTYPE_NONE = 0,
    BSL_BUNDLECRCTYPE_16 = 1,
    BSL_BUNDLECRCTYPE_32 = 2,
} BSL_BundleCRCType_e;
 
typedef struct BSL_HostEID_s
{
    void *handle; 
} BSL_HostEID_t;
 
typedef struct BSL_HostEIDPattern_s
{
    void *handle; 
} BSL_HostEIDPattern_t;
 
typedef struct BSL_BundleRef_s
{
    void *data; 
} BSL_BundleRef_t;
 
typedef struct BSL_PrimaryBlock_s
{
    uint64_t      field_version;              
    uint64_t      field_flags;                
    uint64_t      field_crc_type;             
    BSL_HostEID_t field_dest_eid;             
    BSL_HostEID_t field_src_node_id;          
    BSL_HostEID_t field_report_to_eid;        
    uint64_t      field_bundle_creation_time; 
    uint64_t      field_seq_num;              
    uint64_t      field_lifetime;             
    uint64_t      field_frag_offset;          
    uint64_t      field_adu_length;           
    size_t        block_count; 
    uint8_t      *cbor;
    size_t        cbor_len;
} BSL_PrimaryBlock_t;
 
typedef struct BSL_CanonicalBlock_s
{
    uint64_t block_num; 
    uint64_t type_code; 
    uint64_t flags;     
    uint64_t crc;       
    void    *btsd;      
    size_t   btsd_len;  
} BSL_CanonicalBlock_t;
 
typedef struct
{
    void *user_data;
 
    int (*get_host_eid_fn)(const void *user_data, BSL_HostEID_t *result);
 
    int (*eid_init)(void *user_data, BSL_HostEID_t *result);
 
    void (*eid_deinit)(void *user_data, BSL_HostEID_t *eid);
 
    int (*bundle_metadata_fn)(const BSL_BundleRef_t *bundle_ref, BSL_PrimaryBlock_t *result_primary_block);
 
    int (*bundle_get_block_ids)(const BSL_BundleRef_t *bundle_ref, size_t array_count,
                                uint64_t array_block_ids[array_count], size_t *result_count);
 
    int (*block_metadata_fn)(const BSL_BundleRef_t *bundle_ref, uint64_t block_num, BSL_CanonicalBlock_t *result_block);
 
    int (*block_create_fn)(BSL_BundleRef_t *bundle_ref, uint64_t block_type_code, uint64_t *result_block_num);
 
    int (*block_remove_fn)(BSL_BundleRef_t *bundle_ref, uint64_t block_num);
 
    int (*block_realloc_btsd_fn)(BSL_BundleRef_t *bundle_ref, uint64_t block_num, size_t bytesize);
 
    int (*eid_to_cbor)(void *encoder, const BSL_HostEID_t *eid);
 
    int (*eid_from_cbor)(void *encoder, BSL_HostEID_t *eid);
 
    int (*eid_from_text)(BSL_HostEID_t *eid, const char *text, void *user_data);
 
    int (*eidpat_init)(BSL_HostEIDPattern_t *pat, void *user_data);
 
    void (*eidpat_deinit)(BSL_HostEIDPattern_t *pat, void *user_data);
 
    int (*eidpat_from_text)(BSL_HostEIDPattern_t *pat, const char *text, void *user_data);
 
    bool (*eidpat_match)(const BSL_HostEIDPattern_t *pat, const BSL_HostEID_t *eid, void *user_data);
} BSL_HostDescriptors_t;
 
int BSL_HostDescriptors_Set(BSL_HostDescriptors_t desc);
 
void BSL_HostDescriptors_Get(BSL_HostDescriptors_t *desc);
 
BSL_REQUIRE_CHECK
int BSL_API_InitLib(BSL_LibCtx_t *bsl);
 
BSL_REQUIRE_CHECK
int BSL_API_DeinitLib(BSL_LibCtx_t *bsl);
 
BSL_REQUIRE_CHECK
int BSL_API_RegisterSecurityContext(BSL_LibCtx_t *lib, uint64_t sec_ctx_id, BSL_SecCtxDesc_t desc);
 
BSL_REQUIRE_CHECK
int BSL_API_RegisterPolicyProvider(BSL_LibCtx_t *lib, BSL_PolicyDesc_t desc);
 
BSL_REQUIRE_CHECK
int BSL_API_QuerySecurity(const BSL_LibCtx_t *bsl, BSL_SecurityActionSet_t *output_action_set,
                          const BSL_BundleRef_t *bundle, BSL_PolicyLocation_e location);
 
BSL_REQUIRE_CHECK
int BSL_API_ApplySecurity(const BSL_LibCtx_t *bsl, BSL_SecurityResponseSet_t *response_output, BSL_BundleRef_t *bundle,
                          const BSL_SecurityActionSet_t *policy_actions);
 
#endif /* BSL_BPSECLIB_PUBLIC_H_ */