sopc_secret_buffer.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you 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 SOPC_SECRET_BUFFER_H_
#define SOPC_SECRET_BUFFER_H_
 
#include <stdint.h>
 
// Types
typedef struct SOPC_SecretBuffer SOPC_SecretBuffer;
typedef uint8_t SOPC_ExposedBuffer;
 
/* ------------------------------------------------------------------------------------------------
 * API
 * ------------------------------------------------------------------------------------------------
 */
 
SOPC_SecretBuffer* SOPC_SecretBuffer_NewFromExposedBuffer(const SOPC_ExposedBuffer* buf, uint32_t len);
 
SOPC_SecretBuffer* SOPC_SecretBuffer_NewFromFile(const char* path);
 
SOPC_SecretBuffer* SOPC_SecretBuffer_New(uint32_t len);
 
void SOPC_SecretBuffer_DeleteClear(SOPC_SecretBuffer* sec);
 
uint32_t SOPC_SecretBuffer_GetLength(const SOPC_SecretBuffer* sec);
 
const SOPC_ExposedBuffer* SOPC_SecretBuffer_Expose(const SOPC_SecretBuffer* sec);
 
void SOPC_SecretBuffer_Unexpose(const SOPC_ExposedBuffer* buf, const SOPC_SecretBuffer* sec);
 
SOPC_ExposedBuffer* SOPC_SecretBuffer_ExposeModify(SOPC_SecretBuffer* sec);
 
void SOPC_SecretBuffer_UnexposeModify(SOPC_ExposedBuffer* buf, SOPC_SecretBuffer* sec);
 
#endif // SOPC_SECRET_BUFFER_H_