Skip to content

Commit

Permalink
Merge pull request #115 from nianshao163/main
Browse files Browse the repository at this point in the history 
Support KVS to run using certificate mode through environment variable
  • Loading branch information
@codingspirit
codingspirit authored Dec 11, 2023
2 parents 1720e07 + c05c149 commit 4b442b0
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 44 deletions.
31 changes: 11 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,28 +114,19 @@ make
export AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export AWS_DEFAULT_REGION=us-east-1
```
- Alternatively if you want to use AWS IoT Certificate, add IoT Certificate into [samples/kvsproducer/source/sample_config.h](samples/kvsproducer/source/sample_config.h):
- Alternatively if you want to use AWS IoT Certificate, turn on `ENABLE_IOT_CREDENTIAL` in [samples/kvsproducer/source/sample_config.h](samples/kvsproducer/source/sample_config.h) and using following commands to setup environment variables:
```c
#define ENABLE_IOT_CREDENTIAL 1
#if ENABLE_IOT_CREDENTIAL
#define CREDENTIALS_HOST "xxxxxxxxxxxxxx.credentials.iot.us-east-1.amazonaws.com"
#define ROLE_ALIAS "KvsCameraIoTRoleAlias"
#define THING_NAME KVS_STREAM_NAME
#define ROOT_CA \
"-----BEGIN CERTIFICATE-----\n" \
"......\n" \
"-----END CERTIFICATE-----\n"
#define CERTIFICATE \
"-----BEGIN CERTIFICATE-----\n" \
"......\n" \
"-----END CERTIFICATE-----\n"
#define PRIVATE_KEY \
"-----BEGIN RSA PRIVATE KEY-----\n" \
"......\n" \
"-----END RSA PRIVATE KEY-----\n"
#endif /* ENABLE_IOT_CREDENTIAL */
```
```bash
export AWS_KVS_LOG_LEVEL=2
export AWS_DEFAULT_REGION=us-east-1
export AWS_KVS_CACERT_PATH=rootca.pem
export AWS_IOT_CORE_THING_NAME=your_camera_name
export AWS_IOT_CORE_CREDENTIAL_ENDPOINT=xxxxxxxxxxxxxx.credentials.iot.us-east-1.amazonaws.com
export AWS_IOT_CORE_CERT=your_camera_certificate.pem
export AWS_IOT_CORE_PRIVATE_KEY=your_camera_private.key
export AWS_IOT_CORE_ROLE_ALIAS=your_camera_role_alias
```
6. Make sure your the system time on your board has been synchronized. You may set it manually or use ntp client.
7. Execute sample on your board: `./kvsproducer-static $YOUR_STREAM_NAME`
Expand Down
97 changes: 91 additions & 6 deletions samples/kvsproducer/source/kvsappcli.c
100644 → 100755
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@
static char pMemPool[POOL_ALLOCATOR_SIZE];
#endif

#define SAFE_MEMORYFREE(p) if (p) \
{ \
free(p); \
p = NULL; \
} \

static VideoCapturerHandle videoCapturerHandle = NULL;
static pthread_t videoThreadTid;

Expand Down Expand Up @@ -227,36 +233,115 @@ static void *audioThread(void *arg)
}
#endif /* ENABLE_AUDIO_TRACK */

#if ENABLE_IOT_CREDENTIAL
static int readFile(char* pFileName, char** ppData)
{
FILE* fp = NULL;
char* pData = NULL;

if (ppData == NULL || pFileName == NULL)
{
printf("intput parameter is NULL\n");
return -1;
}

fp = fopen(pFileName, "r");
if (fp)
{
fseek(fp, 0, SEEK_END);
long lSize = ftell(fp);
rewind(fp);
pData = (char *) malloc(lSize);
if (pData)
{
fread(pData, 1, lSize, fp);
}
else
{
fclose(fp);
return -1;
}
fclose(fp);
}
else
{
printf("open file:%s failed\n", pFileName);
return -1;
}

*ppData = pData;
return 0;
}
#endif /* ENABLE_IOT_CREDENTIAL */

static int setKvsAppOptions(KvsAppHandle kvsAppHandle)
{
int res = ERRNO_NONE;

/* Setup credentials, it should be either using IoT credentials or AWS access key. */
#if ENABLE_IOT_CREDENTIAL
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_CREDENTIAL_HOST, (const char *)CREDENTIALS_HOST) != 0)
char *pThingName, *pRootCa, *pCredentialEndPoint, *pCoreCert, *pPrivateKey, *pRoleAlias;
char *pRootCaContext, *pCoreCertContext, *pPrivateKeyContext;

if ((pThingName = getenv(IOT_CORE_THING_NAME)) == NULL)
{
printf("AWS_IOT_CORE_THING_NAME must be set\n");
}
if ((pCoreCert = getenv(IOT_CORE_CERT)) == NULL)
{
printf("AWS_IOT_CORE_CERT must be set\n");
}
if ((pPrivateKey = getenv(IOT_CORE_PRIVATE_KEY)) == NULL)
{
printf("AWS_IOT_CORE_PRIVATE_KEY must be set\n");
}
if ((pRoleAlias = getenv(IOT_CORE_ROLE_ALIAS)) == NULL)
{
printf("AWS_IOT_CORE_ROLE_ALIAS must be set\n");
}
if ((pRootCa = getenv(IOT_CORE_CACERT_PATH)) == NULL)
{
printf("AWS_KVS_CACERT_PATH must be set\n");
}
if ((pCredentialEndPoint = getenv(IOT_CORE_CREDENTIAL_ENDPOINT)) == NULL)
{
printf("AWS_IOT_CORE_CREDENTIAL_ENDPOINT must be set\n");
}

if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_CREDENTIAL_HOST, (const char *)pCredentialEndPoint) != 0)
{
printf("Failed to set credential host\n");
}
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_ROLE_ALIAS, (const char *)ROLE_ALIAS) != 0)
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_ROLE_ALIAS, (const char *)pRoleAlias) != 0)
{
printf("Failed to set role alias\n");
}
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_THING_NAME, (const char *)THING_NAME) != 0)
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_THING_NAME, (const char *)pThingName) != 0)
{
printf("Failed to set thing name\n");
}
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_ROOTCA, (const char *)ROOT_CA) != 0)

res = readFile(pRootCa, &pRootCaContext);
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_ROOTCA, (const char*) pRootCaContext) != 0)
{
printf("Failed to set root CA\n");
}
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_CERT, (const char *)CERTIFICATE) != 0)

res = readFile(pCoreCert, &pCoreCertContext);
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_CERT, (const char *)pCoreCertContext) != 0)
{
printf("Failed to set certificate\n");
}
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_KEY, (const char *)PRIVATE_KEY) != 0)

res = readFile(pPrivateKey, &pPrivateKeyContext);
if (KvsApp_setoption(kvsAppHandle, OPTION_IOT_X509_KEY, (const char *)pPrivateKeyContext) != 0)
{
printf("Failed to set private key\n");
}

SAFE_MEMORYFREE(pRootCaContext);
SAFE_MEMORYFREE(pCoreCertContext);
SAFE_MEMORYFREE(pPrivateKeyContext);
#else
if (KvsApp_setoption(kvsAppHandle, OPTION_AWS_ACCESS_KEY_ID, OptCfg_getAwsAccessKey()) != 0)
{
Expand Down
24 changes: 6 additions & 18 deletions samples/kvsproducer/source/sample_config.h
100644 → 100755
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,24 +65,12 @@

/* IoT credential configuration */
#if ENABLE_IOT_CREDENTIAL
#define CREDENTIALS_HOST "xxxxxxxxxxxxxx.credentials.iot.us-east-1.amazonaws.com"
#define ROLE_ALIAS "KvsCameraIoTRoleAlias"
#define THING_NAME KVS_STREAM_NAME

#define ROOT_CA \
"-----BEGIN CERTIFICATE-----\n" \
"......\n" \
"-----END CERTIFICATE-----\n"

#define CERTIFICATE \
"-----BEGIN CERTIFICATE-----\n" \
"......\n" \
"-----END CERTIFICATE-----\n"

#define PRIVATE_KEY \
"-----BEGIN RSA PRIVATE KEY-----\n" \
"......\n" \
"-----END RSA PRIVATE KEY-----\n"
#define IOT_CORE_CREDENTIAL_ENDPOINT ((char *) "AWS_IOT_CORE_CREDENTIAL_ENDPOINT")
#define IOT_CORE_CERT ((char *) "AWS_IOT_CORE_CERT")
#define IOT_CORE_PRIVATE_KEY ((char *) "AWS_IOT_CORE_PRIVATE_KEY")
#define IOT_CORE_ROLE_ALIAS ((char *) "AWS_IOT_CORE_ROLE_ALIAS")
#define IOT_CORE_THING_NAME ((char *) "AWS_IOT_CORE_THING_NAME")
#define IOT_CORE_CACERT_PATH ((char *) "AWS_KVS_CACERT_PATH")
#endif /* ENABLE_IOT_CREDENTIAL */

#if ENABLE_RING_BUFFER_MEM_LIMIT
Expand Down

0 comments on commit 4b442b0

Please sign in to comment.