NetUtil

Networking related commands and configuration. More...

Functions
_i32	sl_NetUtilSet (const _u16 Option, const _u32 ObjID, const _u8 *pValues, const _u16 ValueLen)
	Function for setting configurations of utilities. More...
_i16	sl_NetUtilGet (const _u16 Option, const _u32 ObjID, _u8 *pValues, _u16 *pValueLen)
	Function for getting configurations of utilities. More...
_i16	sl_NetUtilCmd (const _u16 Cmd, const _u8 *pAttrib, const _u16 AttribLen, const _u8 *pInputValues, const _u16 InputLen, _u8 *pOutputValues, _u16 *pOutputLen)
	Function for performing utilities-related commands. More...

Detailed Description

Networking related commands and configuration.

Function Documentation

sl_NetUtilCmd()

_i16 sl_NetUtilCmd	(	const _u16	Cmd,
		const _u8 *	pAttrib,
		const _u16	AttribLen,
		const _u8 *	pInputValues,
		const _u16	InputLen,
		_u8 *	pOutputValues,
		_u16 *	pOutputLen
	)

Function for performing utilities-related commands.

Parameters

[in]	Cmd	Identifier of the specific Command to perform SL_NETUTIL_CRYPTO_CMD_INSTALL_OP Install / Uninstall key pairs in one or more of the crypto utils key-pair management mechanism. Key Must be an ECC key-pair using SECP256R1 curve and already programmed to file system, in DER format. Key installation is persistent. SL_NETUTIL_CRYPTO_CMD_TEMP_KEYS Creates or removes a temporary key pair. Key pair is created internally by the NWP. Key pair is not persistent over power cycle. SL_NETUTIL_CRYPTO_CMD_SIGN_MSG Signs with a digital signature a data buffer using ECDSA algorithm. SL_NETUTIL_CRYPTO_CMD_VERIFY_MSG Verify a digital signature given with a data buffer using ECDSA algorithm. SL_NETUTIL_CMD_ARP_LOOKUP Mapping MAC address to IPv4 or IPv6 address.
[in]	pAttrib	Pointer to the buffer holding the Attribute values
[in]	AttribLen	Length of the Attribute-values
[in]	pInputValues	Pointer to the buffer holding the input-value
[in]	InputLen	Length of the input-value
[out]	pOutputValues	Pointer to the buffer that the application allocates, and will hold the received data.
[in,out]	pOutputLen	Length of the output-value On input - provides the length of the buffer that the application allocates, and will hold the output On output - provides the actual length of the received output-values

Returns

Zero on success, or negative error code on failure

See also

sl_NetUtilGet sl_NetUtilSet

Note

The host driver API sl_NetUtilCmd is not valid for use with the CC3220R device.
The SL_NETUTIL_CMD_ARP_LOOKUP cmd is only valid for the CC3235S/SF devices.

Warning

Examples

• SL_NETUTIL_CRYPTO_CMD_INSTALL_OP (install / uninstall crypto keys):

  // Install a key
  SlNetUtilCryptoCmdKeyMgnt_t keyAttrib;
  SlNetUtilCryptoPubKeyInfo_t *pInfoKey;
  uint8_t name[FILE_NAME_SIZE];
  int32_t Status;
  int16_t resultLen;
  
  keyAttrib.ObjId = 5; // Key would be stored at index 5
  keyAttrib.SubCmd = SL_NETUTIL_CRYPTO_INSTALL_SUB_CMD;
  pInfoKey->KeyAlgo = SL_NETUTIL_CRYPTO_PUB_KEY_ALGO_EC;
  pInfoKey->KeyParams.EcParams.CurveType = SL_NETUTIL_CRYPTO_EC_CURVE_TYPE_NAMED;                          //ECC curve
  pInfoKey->KeyParams.EcParams.CurveParams.NamedCurveParams = SL_NETUTIL_CRYPTO_EC_NAMED_CURVE_SECP256R1; // SECP256R1 curve only.
  
  pInfoKey->CertFileNameLen = 0;
  name = ((uint8_t *)pInfoKey) + sizeof(SlNetUtilCryptoPubKeyInfo_t);
  name += pInfoKey->CertFileNameLen;
  strcpy((char *)name, "extkey.der"); // Private key name in file system.
  pInfoKey->KeyFileNameLen = strlen("extkey.der")+1;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_INSTALL_OP,
                        (uint8_t *)&keyAttrib, sizeof(SlNetUtilCryptoCmdKeyMgnt_t),
                        (uint8_t *)pInfo,
                        sizeof(SlNetUtilCryptoPubKeyInfo_t) + pInfoKey->KeyFileNameLen,
                        NULL, &resultLen);
  
  // Uninstall the Key:
  resultLen = 0;
  keyAttrib.ObjId = 5;
  keyAttrib.SubCmd = SL_NETUTIL_CRYPTO_UNINSTALL_SUB_CMD;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_INSTALL_OP, (uint8_t *)&keyAttrib,
                         sizeof(SlNetUtilCryptoCmdKeyMgnt_t), NULL, 0 , NULL, &resultLen);

• SL_NETUTIL_CRYPTO_CMD_TEMP_KEYS, (Create a temporary key ):

  SlNetUtilCryptoCmdKeyMgnt_t keyAttrib;
  int32_t Status;
  uint16_t resultLen;
  keyAttrib.ObjId = 1; // key index is 1
  keyAttrib.SubCmd = SL_NETUTIL_CRYPTO_TEMP_KEYS_CREATE;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_TEMP_KEYS,
           (uint8_t *)&keyAttrib, sizeof(SlNetUtilCryptoCmdKeyMgnt_t),
           NULL, 0 , NULL, &resultLen);

• SL_NETUTIL_CRYPTO_CMD_TEMP_KEYS, (Create a temporary key ):

  SlNetUtilCryptoCmdKeyMgnt_t keyAttrib;
  int32_t Status;
  uint16_t resultLen;
  keyAttrib.ObjId = 1; // key index is 1
  keyAttrib.SubCmd = SL_NETUTIL_CRYPTO_TEMP_KEYS_CREATE;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_TEMP_KEYS,
           (uint8_t *)&keyAttrib, sizeof(SlNetUtilCryptoCmdKeyMgnt_t),
           NULL, 0 , NULL, &resultLen);

• SL_NETUTIL_CRYPTO_CMD_SIGN_MSG, (Sign a data buffer):

  int32_t Status;
  int32_t configLen;
  uint8_t messageBuff[1500];
  uint8_t sig_buf[256];      // This buffer shall contain the digital signature.
  SlNetUtilCryptoCmdSignAttrib_t signAttrib;
  
  signAttrib.Flags = 0;
  signAttrib.ObjId = 3;
  signAttrib.SigType = SL_NETUTIL_CRYPTO_SIG_SHAwECDSA; // this is the only type supported
  configLen = 255;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_SIGN_MSG, (uint8_t *)&signAttrib,
                         sizeof(SlNetUtilCryptoCmdSignAttrib_t),
                         messageBuff, sizeof(messageBuf), sig_buf, &configLen);

• SL_NETUTIL_CRYPTO_CMD_VERIFY_MSG, (Verify a data buffer):

  int32_t Status;
  int32_t configLen;
  uint8_t verifyBuf[2048];
  uint8_t messageBuff[1500];
  uint8_t sig_buf[256];                                        // This buffer contains the digital signature.
  int32_t verifyResult;
  SlNetUtilCryptoCmdVerifyAttrib_t verAttrib;
  
  memcpy(verifyBuf, messageBuf, sizeof(messageBuf));           // copy the message to verify buffer.
  memcpy(verifyBuf + sizeof(messageBuff), sig_buf, configLen); // Append the signature to message buffer.
  
  verAttrib.Flags = 0;
  verAttrib.ObjId = 3;
  verAttrib.SigType = SL_NETUTIL_CRYPTO_SIG_SHAwECDSA;         // this is the only type supported, if other hash algorithm
                                                               // is wanted, SL_NETUTIL_CRYPTO_SIG_DIGESTwECDSA is used and
                                                               // the verifyBuf should be the digest and MsgLen should be
                                                               // the digest size
  verAttrib.MsgLen = sizeof(messageBuff);
  verAttrib.SigLen = configLen;
  configLen = 255;
  resultLen = 4;
  
  Status = sl_NetUtilCmd(SL_NETUTIL_CRYPTO_CMD_VERIFY_MSG, (uint8_t *)&verAttrib,
                         sizeof(SlNetUtilCryptoCmdVerifyAttrib_t),
                         verifyBuf, sizeof(messageBuf) + configLen,
                         (uint8_t *)&verifyResult , &resultLen);

  
  

         - SL_NETUTIL_CMD_ARP_LOOKUP, (Mapping MAC address to IPv4 or IPv6 address), CC3235S/SF devices only:

NetUtilCmdArpLookupAttrib_t  arpAttr;
_u32 ipv4;
_u8 macAddr[6];
_u16 outLen = sizeof(macAddr);
_i16 status;

ipv4 = SL_IPV4_VAL(192,168,178,43);
arpAttr.NumOfRetries = 3;
arpAttr.Timeout = 50;

status = sl_NetUtilCmd(SL_NETUTIL_CMD_ARP_LOOKUP, (uint8_t *)&arpAttr, sizeof(arpAttr), (_u8*)&ipv4 , sizeof(ipv4), macAddr,&outLen);
if(status != 0)
{
    // MAC was not found 
}
else
{
    // IP address mapped to MAC
}

Definition at line 162 of file netutil.c.

{
    _i16                RetVal=0;
    SlNetUtilCmdMsg_u   Msg;
    _i16                ObjIdx = MAX_CONCURRENT_ACTIONS;
    _SlCmdExt_t         CmdExt;
    _SlNetUtilCmdData_t OutData;

    /* prepare the Cmd (control structure and data-buffer) */
    Msg.Cmd.Cmd         = Cmd;
    Msg.Cmd.AttribLen   = AttribLen;
    Msg.Cmd.InputLen    = InputLen;
    Msg.Cmd.OutputLen   = *pOutputLen;

    _SlDrvResetCmdExt(&CmdExt);
    _SlDrvMemZero(&OutData, sizeof(_SlNetUtilCmdData_t));

    if(AttribLen > 0)
    {
        CmdExt.pTxPayload1 = (_u8*)pAttrib;
        CmdExt.TxPayload1Len = AttribLen;
    }

    if (InputLen > 0)
    {
        CmdExt.pTxPayload2 = (_u8*)pInputValues;
        CmdExt.TxPayload2Len = InputLen;
    }

    /* Set the pointers to be filled upon the async event reception */
    OutData.pOutputValues = pOutputValues;
    OutData.pOutputLen = pOutputLen;

    ObjIdx = _SlDrvProtectAsyncRespSetting((_u8*)&OutData, NETUTIL_CMD_ID, SL_MAX_SOCKETS);
    if (MAX_CONCURRENT_ACTIONS == ObjIdx)
    {
        return SL_POOL_IS_EMPTY;
    }

    /* send the command */
    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlNetUtilCmdCtrl, &Msg, &CmdExt));

    if(SL_OS_RET_CODE_OK == (_i16)Msg.Rsp.status)
    {
        /* after the async event is signaled, the data will be copied to the pOutputValues buffer  */
        RetVal = _SlDrvWaitForInternalAsyncEvent(ObjIdx, 0, 0);

        if(RetVal >= 0)
        {
            /* the response header status */
            RetVal = OutData.Status;
        }
    }
    else
    {
        RetVal = Msg.Rsp.status;
    }

    _SlDrvReleasePoolObj((_u8)ObjIdx);

    return RetVal;
}

sl_NetUtilGet()

_i16 sl_NetUtilGet	(	const _u16	Option,
		const _u32	ObjID,
		_u8 *	pValues,
		_u16 *	pValueLen
	)

Function for getting configurations of utilities.

Parameters

[in]	Option	Identifier of the specific "get" operation to perform SL_NETUTIL_CRYPTO_PUBLIC_KEY Used to retrieve the public key from an installed key-pair. Saved in a certain index. SL_NETUTIL_TRUE_RANDOM Generates a random number using the internal TRNG of the NWP.
[in]	ObjID	ID of the relevant object that this set operation will be performed on
[in,out]	pValueLen	Pointer to the length of the value parameter On input - provides the length of the buffer that the application allocates, and will hold the output On output - provides the actual length of the received data
[out]	pValues	Pointer to the buffer that the application allocates, and will hold the received data.

Returns

Zero on success, or negative error code on failure.

See also

sl_NetUtilSet sl_NetUtilCmd

Note

Warning

Examples

• SL_NETUTIL_CRYPTO_PUBLIC_KEY:

  int16_t Status;
  uint8_t configOpt = 0;
  uint32_t objId = 0;
  uint16_t configLen = 0;
  uint8_t key_buf[256];
  
  configOpt = SL_NETUTIL_CRYPTO_PUBLIC_KEY;
  
  objId = 1;
  configLen = 255;
  //get the Public key
  Status = sl_NetUtilGet(configOpt, objId, key_buf, &configLen);

• SL_NETUTIL_TRUE_RANDOM:

  uint32_t randNum;
  int32_t len = sizeof(uint32_t);
  
  sl_NetUtilGet(SL_NETUTIL_TRUE_RANDOM, 0, (uint8_t *)&randNum, &len);

  
  

Definition at line 74 of file netutil.c.

{
    SlNetUtilMsgGet_u       Msg;
    _SlCmdExt_t             CmdExt;

    _SlDrvResetCmdExt(&CmdExt);
    CmdExt.RxPayloadLen         = *pValueLen;
    CmdExt.pRxPayload           = (_u8 *)pValues;

    Msg.Cmd.Option              = Option;
    Msg.Cmd.ObjId               = ObjID;
    Msg.Cmd.ValueLen            = *pValueLen;

    VERIFY_RET_OK(_SlDrvCmdOp((_SlCmdCtrl_t *)&_SlNetUtilGetCmdCtrl, &Msg, &CmdExt));

    if(CmdExt.RxPayloadLen < CmdExt.ActualRxPayloadLen)
    {
        *pValueLen = CmdExt.RxPayloadLen;
        return SL_ESMALLBUF;
    }
    else
    {
        *pValueLen = CmdExt.ActualRxPayloadLen;
    }

    return (_i16)Msg.Rsp.Status;
}

sl_NetUtilSet()

_i32 sl_NetUtilSet	(	const _u16	Option,
		const _u32	ObjID,
		const _u8 *	pValues,
		const _u16	ValueLen
	)

Function for setting configurations of utilities.

Parameters

[in]	Option	Identifier of the specific "set" operation to perform
[in]	ObjID	ID of the relevant object that this set operation will be performed on
[in]	ValueLen	Length of the value parameter
[in]	pValues	Pointer to the buffer holding the configurations values

Returns

Zero on success, or negative error code on failure

See also

sl_NetUtilGet sl_NetUtilCmd

Note

Warning

---

Data Structure Documentation

_SlNetUtilCmdData_t

struct _SlNetUtilCmdData_t

Definition at line 88 of file netutil.h.

Data Fields
_u16 *	pOutputLen
_u8 *	pOutputValues
_i16	Status

SlNetUtilCryptoEcCustomCurveParam_t

struct SlNetUtilCryptoEcCustomCurveParam_t

Definition at line 177 of file netutil.h.

Data Fields
_u8	Padding[4]

SlNetUtilCryptoEcCurveParams_u

union SlNetUtilCryptoEcCurveParams_u

Definition at line 184 of file netutil.h.

Data Fields
SlNetUtilCryptoEcCustomCurveParam_t	CustomCurveParams
_u8	NamedCurveParams

SlNetUtilCryptoEcKeyParams_t

struct SlNetUtilCryptoEcKeyParams_t

Definition at line 202 of file netutil.h.

Data Fields
SlNetUtilCryptoEcCurveParams_u	CurveParams
_u8	CurveType

SlNetUtilCryptoPubKeyParams_u

union SlNetUtilCryptoPubKeyParams_u

Definition at line 209 of file netutil.h.

Data Fields
SlNetUtilCryptoEcKeyParams_t	EcParams

SlNetUtilCryptoPubKeyInfo_t

struct SlNetUtilCryptoPubKeyInfo_t

Definition at line 218 of file netutil.h.

Data Fields
_u8	CertFileNameLen
_u8	KeyAlgo
_u8	KeyFileNameLen
SlNetUtilCryptoPubKeyParams_u	KeyParams

SlNetUtilCryptoCmdSignAttrib_t

struct SlNetUtilCryptoCmdSignAttrib_t

Definition at line 230 of file netutil.h.

Data Fields
_u32	Flags
_u32	ObjId
_u32	SigType

SlNetUtilCryptoCmdVerifyAttrib_t

struct SlNetUtilCryptoCmdVerifyAttrib_t

Definition at line 239 of file netutil.h.

Data Fields
_u32	Flags
_u16	MsgLen
_u32	ObjId
_u16	SigLen
_u32	SigType

SlNetUtilCryptoCmdCreateCertAttrib_t

struct SlNetUtilCryptoCmdCreateCertAttrib_t

Definition at line 249 of file netutil.h.

Data Fields
_u32	Flags
_u32	ObjId
_u16	SubCmd

SlNetUtilCryptoCmdKeyMgnt_t

struct SlNetUtilCryptoCmdKeyMgnt_t

Definition at line 258 of file netutil.h.

Data Fields
_u32	Flags
_u32	ObjId
_u16	SubCmd

NetUtilCmdArpLookupAttrib_t

struct NetUtilCmdArpLookupAttrib_t

Definition at line 266 of file netutil.h.

Data Fields
_u16	NumOfRetries
_u16	Timeout