sign-on-basic-client.h

Go to the documentation of this file.

/*
 * Copyright (C) Edward Lu
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v3.0. See the file LICENSE in the top level
 * directory for more details.
 *
 * See AUTHORS.md for complete list of NDN IOT PKG authors and contributors.
 */

#ifndef SIGN_ON_BASIC_CLIENT_H
#define SIGN_ON_BASIC_CLIENT_H

#include "sign-on-basic-client-consts.h"

#include "sign-on-basic-sec-intf-setter.h"

#include <stddef.h>
#include <stdint.h>

typedef int (*sign_on_basic_sec_gen_sha256_hash)(const uint8_t *payload, uint32_t payload_len, 
                                                     uint8_t *output);

typedef int (*sign_on_basic_sec_gen_n1_keypair)(uint8_t *pub_key_buf, uint32_t pub_key_buf_len, 
                                                 uint32_t *pub_key_output_len,
                                                 uint8_t *pri_key_buf, uint32_t pri_key_buf_len, 
                                                 uint32_t *pri_key_output_len);


typedef int (*sign_on_basic_sec_gen_kt)(const uint8_t *N2_pub_key, uint32_t N2_pub_key_len,
                                                    const uint8_t *N1_pri_key, uint32_t N1_pri_key_len,
                                                    uint8_t *output_buf, uint32_t output_buf_len, 
                                                    uint32_t *output_len);

typedef int (*sign_on_basic_sec_gen_btstrp_rqst_sig)(const uint8_t *KS_pri_p, const uint8_t *payload, 
                                                     uint32_t payload_len, uint8_t *output_buf,  
                                                     uint32_t output_buf_len, uint32_t *output_len);

typedef int (*sign_on_basic_sec_vrfy_btstrp_rqst_rspns_sig)(const uint8_t *payload, uint32_t payload_len,
                                                                const uint8_t *sig, uint32_t sig_len,
                                                                const uint8_t *secure_sign_on_code_p, 
                                                                uint32_t secure_sign_on_code_len);

typedef int (*sign_on_basic_sec_gen_cert_rqst_sig)(const uint8_t *KS_pri_p, const uint8_t *payload, 
                                                   uint32_t payload_len, uint8_t *output_buf,  
                                                   uint32_t output_buf_len, uint32_t *output_len);

typedef int (*sign_on_basic_sec_vrfy_cert_rqst_rspns_sig)(const uint8_t *payload, uint32_t payload_len,
                                                                const uint8_t *sig, uint32_t sig_len,
                                                                const uint8_t *KT_p, uint32_t KT_len);

typedef int (*sign_on_basic_sec_decrypt_kd_pri)(uint8_t *KT_p, uint32_t KT_len, 
                                                              const uint8_t *encrypted_kd_pri, 
                                                              uint32_t encrypted_kd_pri_len,
                                                              uint8_t *decrypted_kd_pri, 
                                                              uint32_t decrypted_kd_pri_buf_len,
                                                              uint32_t *decrypted_kd_pri_len);

typedef int (*sign_on_basic_sec_gen_fin_msg_sig)(const uint8_t *KS_pri_p, const uint8_t *payload, 
                                                   uint32_t payload_len, uint8_t *output_buf,  
                                                   uint32_t output_buf_len, uint32_t *output_len);

struct sign_on_basic_sec_intf {
  sign_on_basic_sec_gen_sha256_hash gen_sha256_hash;
  sign_on_basic_sec_gen_n1_keypair gen_n1_keypair;
  sign_on_basic_sec_gen_kt gen_kt;
  sign_on_basic_sec_gen_btstrp_rqst_sig gen_btstrp_rqst_sig;
  sign_on_basic_sec_vrfy_btstrp_rqst_rspns_sig vrfy_btstrp_rqst_rspns_sig;
  sign_on_basic_sec_gen_cert_rqst_sig gen_cert_rqst_sig;
  sign_on_basic_sec_vrfy_cert_rqst_rspns_sig vrfy_cert_rqst_rspns_sig;
  sign_on_basic_sec_decrypt_kd_pri decrypt_kd_pri;
  sign_on_basic_sec_gen_fin_msg_sig gen_fin_msg_sig;
};

typedef struct sign_on_basic_client {

  uint8_t KS_pub_p[SIGN_ON_BASIC_CLIENT_KS_PUB_MAX_LENGTH];
  uint32_t KS_pub_len;

  uint8_t KS_pri_p[SIGN_ON_BASIC_CLIENT_KS_PRI_MAX_LENGTH];
  uint32_t KS_pri_len;

  uint8_t device_identifier_p[SIGN_ON_BASIC_CLIENT_DEVICE_IDENTIFIER_MAX_LENGTH];
  uint32_t device_identifier_len;

  uint8_t device_capabilities_p[SIGN_ON_BASIC_CLIENT_DEVICE_CAPABILITIES_MAX_LENGTH];
  uint32_t device_capabilities_len;

  uint8_t secure_sign_on_code_p[SIGN_ON_BASIC_CLIENT_SECURE_SIGN_ON_CODE_MAX_LENGTH];
  uint32_t secure_sign_on_code_len;

  uint8_t KT_p[SIGN_ON_BASIC_CLIENT_KT_MAX_LENGTH];
  uint32_t KT_len;

  uint8_t N1_pub_p[SIGN_ON_BASIC_CLIENT_N1_PUB_MAX_LENGTH];
  uint32_t N1_pub_len;

  uint8_t N1_pri_p[SIGN_ON_BASIC_CLIENT_N1_PRI_MAX_LENGTH];
  uint32_t N1_pri_len;

  uint8_t N2_pub_p[SIGN_ON_BASIC_CLIENT_N2_PUB_MAX_LENGTH];
  uint32_t N2_pub_len;

  uint8_t trust_anchor_cert_p[SIGN_ON_BASIC_CLIENT_TRUST_ANCHOR_CERT_MAX_LENGTH];
  uint32_t trust_anchor_cert_len;

  uint8_t KD_pub_cert_p[SIGN_ON_BASIC_CLIENT_KD_PUB_CERT_MAX_LENGTH];
  uint32_t KD_pub_cert_len;

  uint8_t KD_pri_p[SIGN_ON_BASIC_CLIENT_KD_PRI_MAX_LENGTH];
  uint32_t KD_pri_len;

  uint8_t status;

  struct sign_on_basic_sec_intf sec_intf;

} sign_on_basic_client_t;

int sign_on_basic_client_init(
                              uint8_t variant,
                              sign_on_basic_client_t *sign_on_basic_client,
                              const uint8_t *device_identifier_p, uint32_t device_identifier_len,
                              const uint8_t *device_capabilities_p, uint32_t device_capabilities_len,
                              const uint8_t *secure_sign_on_code_p,
                              const uint8_t *KS_pub_p, uint32_t KS_pub_len,
                              const uint8_t *KS_pri_p, uint32_t KS_pri_len);

int cnstrct_btstrp_rqst(uint8_t *buf_p, uint32_t buf_len,
                              uint32_t *output_len_p,
                              sign_on_basic_client_t *sign_on_basic_client);

int prcs_btstrp_rqst_rspns(const uint8_t *btstrp_rqst_rspns_buf_p,
                                    uint32_t btstrp_rqst_rspns_buf_len,
                                    sign_on_basic_client_t *sign_on_basic_client);

int cnstrct_cert_rqst(uint8_t *buf_p, uint32_t buf_len, uint32_t *output_len_p,
                            sign_on_basic_client_t *sign_on_basic_client);

int prcs_cert_rqst_rspns(const uint8_t *cert_rqst_rspns_buf_p,
                                  uint32_t cert_rqst_rspns_buf_len,
                                  sign_on_basic_client_t *sign_on_basic_client);

int cnstrct_fin_msg(uint8_t *buf_p, uint32_t buf_len, uint32_t *output_len_p,
                            sign_on_basic_client_t *sign_on_basic_client);

#endif // SIGN_ON_BASIC_CLIENT_H