Oscar Ariza / nRF51822

nordic

Fork of nRF51822 by Nordic Semiconductor

btle/btle_security.h@151:44c40836c82f, 2015-05-08 (annotated)

Committer:
rgrover1
Date:
Fri May 08 15:33:58 2015 +0100
Revision:
151:44c40836c82f
Parent:
150:f6a9caa8c565
Child:
357:55ede9fd5279
Synchronized with git rev 4f10b571

Author: Rohit Grover

initializeSecurity() should take default arguments for security capabilities.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 135:df7e7964a9c3 1 /* mbed Microcontroller Library
rgrover1 135:df7e7964a9c3 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 135:df7e7964a9c3 3 *
rgrover1 135:df7e7964a9c3 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 135:df7e7964a9c3 5 * you may not use this file except in compliance with the License.
rgrover1 135:df7e7964a9c3 6 * You may obtain a copy of the License at
rgrover1 135:df7e7964a9c3 7 *
rgrover1 135:df7e7964a9c3 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 135:df7e7964a9c3 9 *
rgrover1 135:df7e7964a9c3 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 135:df7e7964a9c3 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 135:df7e7964a9c3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 135:df7e7964a9c3 13 * See the License for the specific language governing permissions and
rgrover1 135:df7e7964a9c3 14 * limitations under the License.
rgrover1 135:df7e7964a9c3 15 */
rgrover1 135:df7e7964a9c3 16
rgrover1 135:df7e7964a9c3 17 #ifndef _BTLE_SECURITY_H_
rgrover1 135:df7e7964a9c3 18 #define _BTLE_SECURITY_H_
rgrover1 135:df7e7964a9c3 19
rgrover1 150:f6a9caa8c565 20 #include "Gap.h"
rgrover1 150:f6a9caa8c565 21
rgrover1 135:df7e7964a9c3 22 /**
rgrover1 135:df7e7964a9c3 23 * Enable Nordic's Device Manager, which brings in functionality from the
rgrover1 135:df7e7964a9c3 24 * stack's Security Manager. The Security Manager implements the actual
rgrover1 135:df7e7964a9c3 25 * cryptographic algorithms and protocol exchanges that allow two devices to
rgrover1 135:df7e7964a9c3 26 * securely exchange data and privately detect each other.
rgrover1 135:df7e7964a9c3 27 *
rgrover1 151:44c40836c82f 28 * @param[in] enableBonding Allow for bonding.
rgrover1 151:44c40836c82f 29 * @param[in] requireMITM Require protection for man-in-the-middle attacks.
rgrover1 151:44c40836c82f 30 * @param[in] iocaps To specify IO capabilities of this peripheral,
rgrover1 151:44c40836c82f 31 * such as availability of a display or keyboard to
rgrover1 151:44c40836c82f 32 * support out-of-band exchanges of security data.
rgrover1 151:44c40836c82f 33 * @param[in] passkey To specify a static passkey.
rgrover1 151:44c40836c82f 34 *
rgrover1 135:df7e7964a9c3 35 * @return BLE_ERROR_NONE on success.
rgrover1 135:df7e7964a9c3 36 */
rgrover1 151:44c40836c82f 37 ble_error_t btle_initializeSecurity(bool enableBonding = true,
rgrover1 151:44c40836c82f 38 bool requireMITM = true,
rgrover1 151:44c40836c82f 39 Gap::SecurityIOCapabilities_t iocaps = Gap::IO_CAPS_NONE,
rgrover1 151:44c40836c82f 40 const Gap::Passkey_t passkey = NULL);
rgrover1 135:df7e7964a9c3 41
rgrover1 138:aafab7b0a8bd 42 /**
rgrover1 139:750eca573e18 43 * Get the security status of a link.
rgrover1 139:750eca573e18 44 *
rgrover1 139:750eca573e18 45 * @param[in] connectionHandle
rgrover1 139:750eca573e18 46 * Handle to identify the connection.
rgrover1 139:750eca573e18 47 * @param[out] securityStatusP
rgrover1 139:750eca573e18 48 * security status.
rgrover1 139:750eca573e18 49 *
rgrover1 139:750eca573e18 50 * @return BLE_SUCCESS Or appropriate error code indicating reason for failure.
rgrover1 139:750eca573e18 51 */
rgrover1 139:750eca573e18 52 ble_error_t btle_getLinkSecurity(Gap::Handle_t connectionHandle, Gap::LinkSecurityStatus_t *securityStatusP);
rgrover1 139:750eca573e18 53
rgrover1 139:750eca573e18 54 /**
rgrover1 138:aafab7b0a8bd 55 * Function for deleting all peer device context and all related bonding
rgrover1 138:aafab7b0a8bd 56 * information from the database.
rgrover1 138:aafab7b0a8bd 57 *
rgrover1 138:aafab7b0a8bd 58 * @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure.
rgrover1 138:aafab7b0a8bd 59 * @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization and/or
rgrover1 138:aafab7b0a8bd 60 * application registration.
rgrover1 138:aafab7b0a8bd 61 */
rgrover1 141:3a5282e3f30c 62 ble_error_t btle_purgeAllBondingState(void);
rgrover1 138:aafab7b0a8bd 63
rgrover1 135:df7e7964a9c3 64 #endif /* _BTLE_SECURITY_H_ */