smp_calculate_link_key_from_long_term_key() function

* Function smp_sm_event * Description Handle events to the state machine. It looks up the entry * in the smp_entry_table array. * If it is a valid entry, it gets the state table.Set the next state, * if not NULL state.Execute the action function according to the * state table. If the state returned by action function is not NULL * state, adjust the new state to the returned state.If (api_evt != MAX), * call callback function. * Returns void.

* Function smp_br_state_machine_event * Description Handle events to the state machine. It looks up the entry * in the smp_br_entry_table array. * If it is a valid entry, it gets the state table.Set the next state, * if not NULL state. Execute the action function according to the * state table. If the state returned by action function is not NULL * state, adjust the new state to the returned state. * Returns void.

* Function smp_send_cmd * Description send a SMP command on L2CAP channel.

* Function smp_command_has_valid_fixed_length * Description Checks if the received command size is equal to the size * according to specs. * Returns TRUE if the command size is as expected, FALSE otherwise. * Note The command is expected to have fixed length.

* Function smp_parameter_unconditionally_valid * Description Always returns TRUE.

* Function smp_command_has_invalid_parameters * Description Checks if the received SMP command has invalid parameters i.e. * if the command length is valid and the command parameters are * inside specified range. * It returns TRUE if the command has invalid parameters. * Returns TRUE if the command has invalid parameters, FALSE otherwise.

* Function smp_update_key_mask * Description This function updates the key mask for sending or receiving.

* Function smp_key_distribution * Description start key distribution if required.

* Function smp_send_rand * Description send pairing random to the peer

CLASSIC_BT_INCLUDED == TRUE * Function smp_key_distribution_by_transport * Description depending on the transport used at the moment calls either * smp_key_distribution(...) or smp_br_key_distribution(...).

* Function smp_start_nonce_generation * Description This function starts nonce generation. * Returns void

* Function smp_collect_local_ble_address * Description This function puts into le_addr array local device le address: * le_addr[0-5] = local BD ADDR, * le_addr[6] = local le address type (PUBLIC/RANDOM). * Returns void

* Function smp_collect_peer_ble_address * Description This function puts into le_addr array peer device le address: * le_addr[0-5] = peer BD ADDR, * le_addr[6] = peer le address type (PUBLIC/RANDOM). * Returns void

* Function SMP_SEND_COMMITMENT * Description send commitment command to the peer

* Function smp_decide_association_model * Description This function is called to select assoc model to be used for * STK generation and to start STK generation process.

* Function smp_proc_pairing_cmpl * Description This function is called to process pairing complete * Returns void

* Function smp_check_commitment * Description This function compares peer commitment values: * - expected (i.e. calculated locally), * - received from the peer. * Returns TRUE if the values are the same * FALSE otherwise

BLE_INCLUDED == TRUE * Function smp_request_oob_data * Description Requests application to provide OOB data. * Returns TRUE - OOB data has to be provided by application * FALSE - otherwise (unexpected)

* Function smp_generate_srand_mrand_confirm * Description This function is called to start the second pairing phase by * start generating random number. * Returns void

* Function smp_generate_passkey * Description This function is called to generate passkey. * Returns void

* Function smp_send_app_cback * Description notifies application about the events the application is interested in

* Function smp_send_id_info * Description send ID information command.

* Function smp_send_pair_rsp * Description actions related to sending pairing response

* Function smp_br_select_next_key * Description selects the next key to derive/send when BR/EDR transport is * used.

* Function smp_select_association_model * Description This function selects association model to use for STK * generation. Selection is based on both sides' io capability, * oob data flag and authentication request. * Note If Secure Connections Only mode is required locally then we * come to this point only if both sides support Secure Connections * mode, i.e. if p_cb->secure_connections_only_mode_required = TRUE then we come * to this point only if * (p_cb->peer_auth_req & SMP_SC_SUPPORT_BIT) == * (p_cb->loc_auth_req & SMP_SC_SUPPORT_BIT) == * SMP_SC_SUPPORT_BIT

* Function smp_process_private_key * Description This function processes private key. * It calculates public key and notifies SM that private key / * public key pair is created. * Returns void

* Function smp_generate_ltk_cont * Description This function is to calculate LTK = d1(ER, DIV, 0)= e(ER, DIV) * Returns void

* Function smp_save_secure_connections_long_term_key * Description The function saves SC LTK as BLE key for future use as local * and/or peer key. * Returns void

* Function smp_generate_compare * Description This function is called to generate SConfirm for Slave device, * or MSlave for Master device. This function can be also used for * generating Compare number for confirm value check. * Returns void

* Function smp_generate_stk * Description This function is called to generate STK calculated by running * AES with the TK value as key and a concatenation of the random * values. * Returns void

* Function smp_generate_ltk * Description This function is called: * - in legacy pairing - to calculate LTK, starting with DIV * generation; * - in LE Secure Connections pairing over LE transport - to process LTK * already generated to encrypt LE link; * - in LE Secure Connections pairing over BR/EDR transport - to start * BR/EDR Link Key processing. * Returns void

* Function smp_generate_rand_cont * Description This function is called to generate another 64 bits random for * MRand or Srand. * Returns void

* Function smp_use_oob_private_key * Description This function is called * - to save the secret key used to calculate the public key used * in calculations of commitment sent OOB to a peer * - to use this secret key to recalculate the public key and * start the process of sending this public key to the peer * if secret/public keys have to be reused. * If the keys aren't supposed to be reused, continue from the * point from which request for OOB data was issued. * Returns void

* Function smp_calculate_local_commitment * Description The function calculates and saves local commmitment in CB. * Returns void

* Function smp_send_pair_req * Description actions related to sending pairing request

* Function smp_send_pair_fail * Description pairing failure to peer device if needed.

* Function smp_send_pair_public_key * Description send pairing public key command to the peer

* Function smp_proc_pair_fail * Description process pairing failure from peer device

* Function smp_proc_enc_info * Description process identity information from peer device

* Function smp_proc_id_addr * Description process identity address from peer device

* Function smp_pair_terminate * Description This function is called to send the pairing complete callback * and remove the connection if needed.

* Function smp_idle_terminate * Description This function calledin idle state to determine to send authentication * complete or not.

* Function smp_proc_srk_info * Description process security information from peer device

* Function smp_key_pick_key * Description Pick a key distribution function based on the key mask.

* Function smp_wait_for_both_public_keys * Description generates SMP_BOTH_PUBL_KEYS_RCVD_EVT event when both local and master * public keys are available. * Note on the slave it is used to prevent race condition.

* Function smp_process_secure_connection_oob_data * Description Processes local/peer SC OOB data received from somewhere.

* Function smp_br_send_pair_response * Description actions related to sending pairing response over BR/EDR transport.

* Function smp_cb_cleanup * Description Clean up SMP control block * Returns void

* Function smp_reset_control_value * Description This function is called to reset the control block value when * pairing procedure finished. * Returns void

* Function smp_generate_confirm * Description This function is called when a 48 bits random number is generated * as SRand or MRand, continue to calculate Sconfirm or MConfirm. * Returns void

* Function smp_generate_y * Description This function is to proceed generate Y = E(DHK, Rand) * Returns void

* Function smp_generate_rand_vector * Description This function is called when LTK is generated, send state machine * event to SMP. * Returns void

* Function smp_pairing_request_response_parameters_are_valid * Description Validates parameter ranges in the received SMP command * pairing request or pairing response. * The parameters to validate: * IO capability, * OOB data flag, * Bonding_flags in AuthReq * Maximum encryption key size. * Returns FALSE if at least one of these parameters is out of range.

* Function smp_parameter_unconditionally_invalid * Description Always returns FALSE.

* Function smp_build_pairing_req_cmd * Description Build pairing request command.

* Function smp_collect_local_io_capabilities * Description This function puts into IOcap array local device * IOCapability, OOB data, AuthReq. * Returns void

* Function smp_collect_peer_io_capabilities * Description This function puts into IOcap array peer device * IOCapability, OOB data, AuthReq. * Returns void

* Function smp_calculate_f5_mackey_and_long_term_key * Description The function calculates MacKey and LTK and saves them in CB. * To calculate MacKey and LTK it calls smp_calc_f5(...). * MacKey is used in dhkey calculation, LTK is used to encrypt * the link. * Returns FALSE if out of resources, TRUE otherwise.

* Function smp_remove_fixed_channel * Description This function is called to remove the fixed channel * Returns void

* Function smp_create_private_key * Description This function is called to create private key used to * calculate public key and DHKey. * The function starts private key creation requesting controller * to generate [0-7] octets of private key. * Returns void

* Function smp_compute_dhkey * Description The function: * - calculates a new public key using as input local private * key and peer public key; * - saves the new public key x-coordinate as DHKey. * Returns void

* Function smp_calculate_peer_commitment * Description The function calculates and saves peer commmitment at the * provided output buffer. * Returns void

* Function smp_calculate_numeric_comparison_display_number * Description The function calculates and saves number to display in numeric * comparison association mode. * Returns void

* Function smp_calculate_local_dhkey_check * Description The function calculates and saves local device DHKey check * value in CB. * Before doing this it calls smp_calculate_f5_mackey_and_long_term_key(...). * to calculate MacKey and LTK. * MacKey is used in dhkey calculation. * Returns void

* Function smp_calculate_peer_dhkey_check * Description The function calculates peer device DHKey check value. * Returns void

* Function smp_calculate_long_term_key_from_link_key * Description The function calculates and saves SC LTK derived from BR/EDR * link key. * Returns FALSE if out of resources, TRUE in other cases.

* Function smp_send_confirm * Description send confirmation to the peer

* Function smp_send_dhkey_check * Description send DHKey Check command to the peer

* Function smp_send_keypress_notification * Description send Keypress Notification command to the peer

BLE_INCLUDED == TRUE * Function smp_proc_confirm * Description process pairing confirm from peer device

* Function smp_proc_rand * Description process pairing random (nonce) from peer device

* Function smp_process_pairing_public_key * Description process pairing public key command from the peer device * - saves the peer public key; * - sets the flag indicating that the peer public key is received; * - calls smp_wait_for_both_public_keys(...).

CLASSIC_BT_INCLUDED == TRUE * Function smp_proc_enc_info * Description process encryption information from peer device

BLE_INCLUDED == TRUE * Function smp_proc_master_id * Description process master ID from slave device

BLE_INCLUDED == TRUE * Function smp_proc_sec_grant * Description process security grant.

* Function smp_proc_sec_req * Description process security request.

* Function smp_proc_sl_key * Description process key ready events.

* Function smp_start_enc * Description start encryption

* Function smp_enc_cmpl * Description encryption success

BLE_INCLUDED == TRUE * Function smp_proc_discard * Description processing for discard security request

* Function smp_pairing_cmpl * Description This function is called to send the pairing complete callback * and remove the connection if needed.

* Function smp_proc_compare * Description process compare value

* Function smp_check_auth_req * Description check authentication request

* Function smp_process_io_response * Description process IO response for a slave device.

* Function smp_send_enc_info * Description send encryption information command.

* Function smp_send_csrk_info * Description send CSRK command.

* Function smp_send_ltk_reply * Description send LTK reply

* Function smp_proc_pair_cmd * Description Process the SMP pairing request/response from peer device

* Function smp_generate_csrk * Description This function is called to calculate CSRK, starting with DIV * generation. * Returns void

* Function smp_fast_conn_param * Description apply default connection parameter for pairing process

* Function smp_both_have_public_keys * Description The function is called when both local and peer public keys are * saved. * Actions: * - invokes DHKey computation; * - on slave side invokes sending local public key to the peer. * - invokes SC phase 1 process.

* Function smp_start_secure_connection_phase1 * Description The function starts Secure Connection phase1 i.e. invokes initialization of Secure Connection * phase 1 parameters and starts building/sending to the peer * messages appropriate for the role and association model.

* Function smp_process_local_nonce * Description The function processes new local nonce. * Note It is supposed to be called in SC phase1.

* Function smp_process_pairing_commitment * Description process pairing commitment from peer device

* Function smp_process_peer_nonce * Description The function processes newly received and saved in CB peer nonce. * The actions depend on the selected association model and the role. * Note It is supposed to be called in SC phase1.

* Function smp_process_dhkey_check * Description process DHKey Check from peer device

BLE_INCLUDED == TRUE * Function smp_match_dhkey_checks * Description checks if the calculated peer DHKey Check value is the same as * received from the peer DHKey check value.

* Function smp_process_keypress_notification * Description process pairing keypress notification from peer device

* Function smp_move_to_secure_connections_phase2 * Description Signal State Machine to start SC phase 2 initialization (to * compute local DHKey Check value). * Note SM is supposed to be in the state SMP_STATE_SEC_CONN_PHS2_START.

* Function smp_phase_2_dhkey_checks_are_present * Description generates event if dhkey check from the peer is already received. * Note It is supposed to be used on slave to prevent race condition. * It is supposed to be called after slave dhkey check is calculated.

* Function smp_start_passkey_verification * Description Starts SC passkey entry verification.

* Function smp_set_local_oob_keys * Description Saves calculated private/public keys in sc_oob_data.loc_oob_data, * starts nonce generation * (to be saved in sc_oob_data.loc_oob_data.randomizer).

* Function smp_set_local_oob_random_commitment * Description Saves calculated randomizer and commitment in sc_oob_data.loc_oob_data, * passes sc_oob_data.loc_oob_data up for safekeeping.

* Function smp_set_derive_link_key * Description This function is called to set flag that indicates that * BR/EDR LK has to be derived from LTK after all keys are * distributed. * Returns void

* Function smp_derive_link_key_from_long_term_key * Description This function is called to derive BR/EDR LK from LTK. * Returns void

* Function smp_br_process_pairing_command * Description Process the SMP pairing request/response from peer device via * BR/EDR transport.

* Function smp_br_process_security_grant * Description process security grant in case of pairing over BR/EDR transport.

BLE_INCLUDED == TRUE * Function smp_br_process_slave_keys_response * Description process application keys response for a slave device * (BR/EDR transport).

* Function smp_br_check_authorization_request * Description sets the SMP kes to be derived/distribute over BR/EDR transport * before starting the distribution/derivation

BLE_INCLUDED == TRUE * Function smp_br_process_link_key * Description This function is called to process BR/EDR LK: * - to derive SMP LTK from BR/EDR LK; 8 - to save SMP LTK. * Returns void

* Function smp_br_pairing_complete * Description This function is called to send the pairing complete callback * and remove the connection if needed.

* Function smp_calculate_legacy_short_term_key * Description The function calculates legacy STK. * Returns FALSE if out of resources, TRUE in other cases.

* Function smp_continue_private_key_creation * Description This function is used to continue private key creation. * Returns void

* Function smp_concatenate_peer * add pairing command received from peer device into p1.

* Function smp_calculate_comfirm * Description This function is called to calculate Confirm value. * Returns void

* Function smp_calculate_comfirm_cont * Description This function is called when SConfirm/MConfirm is generated * proceed to send the Confirm request/response to peer device. * Returns void

* Function smp_process_confirm * Description This function is called when SConfirm/MConfirm is generated * proceed to send the Confirm request/response to peer device. * Returns void

* Function smp_process_compare * Description This function is called when Compare is generated using the * RRand and local BDA, TK information. * Returns void

* Function smp_process_stk * Description This function is called when STK is generated * proceed to send the encrypt the link using STK. * Returns void

* Function smp_process_ediv * Description This function is to calculate EDIV = Y xor DIV * Returns void

* Function smp_finish_nonce_generation * Description This function finishes nonce generation. * Returns void

* Function smp_process_new_nonce * Description This function notifies SM that it has new nonce. * Returns void

* Function smp_compute_csrk * Description This function is called to calculate CSRK * Returns void

* Function smp_concatenate_peer * add pairing command sent from local device into p1.

* Function smp_build_security_request * Description Build security request command.

* Function smp_build_pair_public_key_cmd * Description Build pairing public key command.

* Function smp_build_pairing_commitment_cmd * Description Build pairing commitment command.

* Function smp_build_pair_dhkey_check_cmd * Description Build pairing DHKey check command.

* Function smp_build_pairing_keypress_notification_cmd * Description Build keypress notification command.

* Function smp_pairing_keypress_notification_is_valid * Description Validates Notification Type parameter range in the received SMP command * pairing keypress notification. * Returns FALSE if this parameter is out of range.

* Function smp_select_legacy_association_model * Description This function is called to select association mode if at least * one side doesn't support secure connections.

* Function smp_select_association_model_secure_connections * Description This function is called to select association mode if both * sides support secure connections.

* Function smp_build_confirm_cmd * Description Build confirm request command.

* Function smp_build_rand_cmd * Description Build Random command.

* Function smp_build_encrypt_info_cmd * Description Build security information command.

* Function smp_build_master_id_cmd * Description Build security information command.

* Function smp_build_identity_info_cmd * Description Build identity information command.

* Function smp_build_id_addr_cmd * Description Build identity address information command.

* Function smp_build_signing_info_cmd * Description Build signing information command.

* Function smp_build_pairing_fail * Description Build Pairing Fail command.

* Function smp_gen_p1_4_confirm * Description Generate Confirm/Compare Step1: * p1 = pres || preq || rat' || iat' * Returns void

* Function smp_gen_p2_4_confirm * Description Generate Confirm/Compare Step2: * p2 = padding || ia || ra * Returns void

* Function smp_proc_passkey * Description This function is called to process a passkey. * Returns void