System onboarding to AWS IoT utilizing Digital Personal Cloud endpoints

Introduction

In case you function safe personal networks—comparable to an meeting line’s operational expertise (OT) community at a manufacturing unit or authorities company­—and intend to attach your units to AWS, then you should use X.509 consumer certificates for authenticating requests to AWS providers—all whereas staying throughout the Digital Personal Cloud (VPC). On this publish, we are going to reveal learn how to use the brand new functionality, VPC endpoint (VPCe) for AWS IoT Core credential supplier to handle part deployments into AWS IoT Greengrass-powered gateways operating on personal networks. Equally, we will even reveal learn how to develop and join units that use AWS IoT System SDK and require alternate of X.509 consumer certificates for safety tokens to work together with different AWS providers.

AWS IoT Core is a totally managed service that helps connectivity for billions of units. Gadgets and software program purchasers that hook up with AWS IoT Core depend on X.509 certificates for authentication. Nonetheless, different AWS providers depend on safety tokens to authenticate API calls. To keep away from hardcoding credentials and/or tokens within the purchasers, AWS IoT Core supplies AWS IoT Core credential supplier endpoint. This endpoint permits purchasers, like AWS IoT Greengrass elements, to alternate their X.509 certificates as safety tokens to work together with different AWS providers. Furthermore, with AWS IoT Core’s credential supplier endpoint functionality, you may prolong your operational networks to a VPC in AWS through Digital Personal Community (VPN), thus eliminating the necessity in your tools to make use of public web entry to achieve AWS IoT Core’s credential supplier.

How clients are benefiting from the brand new functionality

Pre-requisites

• Administrator entry to an AWS account
• Fundamental AWS CLI abilities
• Fundamental AWS IoT Greengrass and AWS IoT Core information

Answer structure

The next structure represents a typical IoT infrastructure the place units utilizing on-premises operational networks hook up with AWS via a personal community.

Walkthrough

On this walkthrough you’ll learn to use AWS IoT Core credential supplier to allow a VPCe connection both for AWS IoT Greengrass or IoT units developed utilizing the AWS IoT System SDK. 

Be aware that you will need to implement the part “Create VPC endpoints” for each circumstances.

AWS IoT Greengrass

Create VPC endpoints

To determine an edge-to-cloud communication hyperlink fully over VPC, you will need to first setup AWS Direct Join between your on-premises community infrastructure and your AWS VPC. For detailed implementation, please check with AWS Direct Join developer information.

As soon as AWS Direct Join is setup, there are 3 VPC Endpoints required for an IoT gateway to be provisioned, managed, and synchronized (part deployments) as an AWS IoT Greengrass gateway.

• AWS IoT Greengrass
• AWS IoT Core information
• AWS IoT Core credential supplier

The AWS IoT Greengrass endpoint (com.amazonaws.[region].greengrass) is used to handle elements, deployments, and units from the AWS IoT Greengrass cloud service. Authentication and authorization with this endpoint are finished utilizing X.509 certificates as described in System authentication and authorization for AWS IoT Greengrass.

The AWS IoT Core information endpoint (com.amazonaws.[region].iot.information) is used for interactions between AWS IoT Greengrass elements and AWS IoT Core by publishing/subscribing to AWS IoT Core MQTT dealer. Authentication and authorization with this endpoint can be finished utilizing X.509 certificates.

The AWS IoT Core credential supplier endpoint (com.amazonaws.[region].iot.credentials) is used to speak with different AWS providers that don’t assist X.509 authentication and authorization, comparable to Amazon Easy Storage Service (Amazon S3) and Amazon Elastic Container Registry (Amazon ECR). In both case, the units developed utilizing the AWS IoT SDK or an AWS IoT Greengrass part, will name the AWS IoT Core credential supplier endpoint utilizing the X.509 certificates to authenticate and get licensed. The endpoint will then difficulty a short lived safety token for the consumer to make use of within the name to the providers not supporting X.509.

Calls to Amazon S3 and Amazon ECR are required throughout AWS IoT Greengrass part deployments as described within the following sequence diagram. The AWS IoT Greengrass part will even require a safety token if it makes use of AWS SDKs to speak with different cloud providers not supporting X.509 certificates authentication and authorization.

Then, to perform an end-to-end VPCe communication, you will need to create these 3 VPC endpoints pointing to a number of personal subnets chosen to route visitors to and from AWS.

Every VPC endpoint will get an Web Protocol (IP) handle, one for every personal subnet the place the VPCe is created. We advocate choosing a minimum of 2 subnets for prime availability.

You should use the next AWS CLI instructions to create the three VPC endpoints passing your personal subnet as parameters or use the AWS Console to create them.

All following instructions are for us-east-1 area.

1. Create VPC endpoints

aws ec2 create-vpc-endpoint --vpc-id <YOUR VPCID> --vpc-endpoint-type Interface --service-name com.amazonaws.us-east-1.iot.credentials | jq -r ".VpcEndpoint.VpcEndpointId"
aws ec2 create-vpc-endpoint --vpc-id <YOUR VPCID> --vpc-endpoint-type Interface --service-name com.amazonaws.us-east-1.greengrass | jq -r ".VpcEndpoint.VpcEndpointId"
aws ec2 create-vpc-endpoint --vpc-id <YOUR VPCID> --vpc-endpoint-type Interface --service-name com.amazonaws.us-east-1.iot.information | jq -r ".VpcEndpoint.VpcEndpointId"

2. Get safety teams related to the VPC endpoints

Utilizing the VPC endpoints IDs returned by the instructions carried out within the step 1, apply the next command to get the safety teams related to them.

aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.credentials VpcEndpointId> | jq -r ".VpcEndpoints[0].Teams[0].GroupId"
aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.greengrass VpcEndpointId> | jq -r ".VpcEndpoints[0].Teams[0].GroupId"
aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.information VpcEndpointId> | jq -r ".VpcEndpoints[0].Teams[0].GroupId"

The safety groupId will more than likely be the identical for all of your VPC endpoints. If that’s the case, you may run steps 3 and 4 simply as soon as.

3. Add ingress rule to the safety teams

Utilizing the Safety Teams IDs returned by the instructions within the step 2, run the next command to permit ingress communication from the IP vary the place your AWS IoT Greengrass machine will probably be operating.

On this weblog publish, for simplicity, we enable ingress from anyplace (0.0.0.0), however we advocate you restrict the ingress to the CidrIp the place your AWS IoT Greengrass machine will probably be deployed.

aws ec2 authorize-security-group-ingress --group-id <.iot.credentials GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443
aws ec2 authorize-security-group-ingress --group-id <.greengrass GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443
aws ec2 authorize-security-group-ingress --group-id <.iot.information GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443

4. Add egress rule to the safety teams

Utilizing the Safety Teams IDs returned by the instructions executed in step 2, run the next command to permit egress communication to the IP vary the place your AWS IoT Greengrass machine will probably be operating.

On this weblog publish, for simplicity, we enable egress to anyplace (0.0.0.0), however we advocate you restrict the egress to the CidrIp the place your Greengrass machine will probably be deployed.

aws ec2 authorize-security-group-egress --group-id <.iot.credentials GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443
aws ec2 authorize-security-group-egress --group-id <.greengrass GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443
aws ec2 authorize-security-group-egress --group-id <.iot.information GroupID> --protocol tcp --cidr 0.0.0.0/0 --port 443

5. Add subnets to the VPC endpoints

As soon as the VPC endpoints have being created and configured, you may comply with the Amazon Digital Public Cloud documentation so as to add or take away subnets to the VPC endpoint. We advocate configuring a minimum of 2 subnets in every endpoint for HA.

6. Allow DNS assist for the VPC

Run the next instructions to allow DNS assist within the VPC the place the VPC endpoints had been created.

aws ec2 modify-vpc-attribute --vpc-id <YOUR VPCID> --enable-dns-support "{"Worth":true}"
aws ec2 modify-vpc-attribute --vpc-id <YOUR VPCID> --enable-dns-hostnames "{"Worth":true}"

7. Create personal hosted zone in Amazon Route 53

Subsequent step is to configure a personal hosted zone in Amazon Route 53.

First create a hosted zone for every VPC endpoint.

echo '{
"VPCRegion":"us-east-1",
"VPCId":"<YOUR VPCID>"
}' > vpc.json

echo '{
"Remark": "PrivateZoneForVPCe",
"PrivateZone": true
}' > hostedzoneconfig.json

aws route53 create-hosted-zone --name credentials.iot.us-east-1.amazonaws.com --vpc file://vpc.json --caller-reference <UUID> --hosted-zone-config file://hostedzoneconfig.json |jq -r ".HostedZone.Id"|sed 's?^.*hostedzone/??g'
aws route53 create-hosted-zone --name iot.us-east-1.amazonaws.com --vpc file://vpc.json --caller-reference <UUID> --hosted-zone-config file://hostedzoneconfig.json |jq -r ".HostedZone.Id"|sed 's?^.*hostedzone/??g'

You should use the next on-line instrument to generate the required UUIDs https://www.uuidgenerator.internet/version1

Then you definitely get:

a. VPC endpoints addresses

aws iot describe-endpoint --endpoint-type iot:CredentialProvider | jq -r '.endpointAddress'
aws iot describe-endpoint --endpoint-type iot:Knowledge-ATS | jq -r '.endpointAddress'

b. VPC endpoints DNS names

aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.credentials VpcEndpointId FROM STEP 1> | jq -r ".VpcEndpoints[0].DnsEntries[0].DnsName"
aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.information VpcEndpointId FROM STEP 1> | jq -r ".VpcEndpoints[0].DnsEntries[0].DnsName"

c. Hosted Zone IDs

aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.credentials VpcEndpointId FROM STEP 1> | jq -r ".VpcEndpoints[0].DnsEntries[0].HostedZoneId"
aws ec2 describe-vpc-endpoints --vpc-endpoint-ids <.iot.information VpcEndpointId FROM STEP 1> | jq -r ".VpcEndpoints[0].DnsEntries[0].HostedZoneId"

With the data from sections 7.a, 7.b, and seven.c, you may create the DNS file within the Personal Hosted Zones.

Credential endpoint:

echo '{
"Remark": "Route visitors from Credential default endpoint to VPCe.",
"Modifications": [
{
"Action": "UPSERT",
"ResourceRecordSet": {
"Name": "<Credentials Endpoint Address from 7.a",
"Type": "A",
"AliasTarget": {
"HostedZoneId": "<Credentials Endpoint Hosted Zone ID from 7.c>",
"DNSName": "<Credentials Endpoint DNS name from 7.b>",
"EvaluateTargetHealth": true
}
}
}
]
}' > credentialvpce.json

aws route53 change-resource-record-sets --hosted-zone-id <Hosted Zone Id of your Route53 hosted zone> --change-batch file://credentialvpce.json

IMPORTANT

HostedZoneId within the credentialvpce.json is the ID you will discover within the credentials VPCe console definition between parenthesis below the DNS Names part. It’s also returned by the command “aws ec2 describe-vpc-endpoints —vpc-endpoint-ids <.iot.credentials VpcEndpointId FROM STEP 1> ……” from part 7.c

–hosted-zone-id parameter within the AWS CLI command is the Hosted Zone Id returned by the command “aws route53 create-hosted-zone —title credentials.us-east-1.iot.amazonaws.com …….” Yow will discover this ID additionally within the Amazon Route 53 console, by choosing your hosted zone and navigating to the “Hosted zone particulars” part.

Knowledge endpoint:

echo '{
"Remark": "Route visitors from IoT Core default information endpoint to VPCe.",
"Modifications": [
{
"Action": "UPSERT",
"ResourceRecordSet": {
"Name": "<Data Endpoint Address from 7.a",
"Type": "A",
"AliasTarget": {
"HostedZoneId": "<Data Endpoint Hosted Zone ID from 7.c>",
"DNSName": "<Data Endpoint DNS name from 7.b>",
"EvaluateTargetHealth": true
}
}
}
]
}' > datavpce.json

aws route53 change-resource-record-sets --hosted-zone-id <Hosted Zone Id of your Route53 hosted zone> --change-batch file://datavpce.json

Deploy and join your AWS IoT Greengrass core machine

Now you can comply with any of the supported strategies to configure your AWS IoT Greengrass core machine. On this state of affairs, you might be more than likely working in an setting with out web entry to obtain packages into the machine the place you’ll set up AWS IoT Greengrass nucleus. We advocate following Set up with guide provisioning.

Earlier than operating the set up command:

sudo -E java -Droot="/greengrass/v2" -Dlog.retailer=FILE 
-jar ./GreengrassInstaller/lib/Greengrass.jar 
--init-config ./GreengrassInstaller/config.yaml 
--component-default-user ggc_user:ggc_group 
--setup-system-service true

It’s a must to examine your “./GreengrassInstaller/config.yaml” appears like the next:

system:
certificateFilePath: "/greengrass/v2/[your thing cert]"
privateKeyPath: "/greengrass/v2/[your thing private key]"
rootCaPath: "/greengrass/v2/AmazonRootCA1.pem"
rootpath: "/greengrass/v2"
thingName: "[your thing name]"
providers:
aws.greengrass.Nucleus:
componentType: "NUCLEUS"
model: "[your NUCLEUS version]"
configuration:
awsRegion: "us-east-1"
iotRoleAlias: "[your GreengrassCoreTokenExchangeRoleAlias]"
iotDataEndpoint: "[the 'A' record created in Route53 for IoT Data Enpoint]"
iotCredEndpoint: "[the 'A' record created in Route53 for IoT Credential Endpoin]"
mqtt:
port: 443
greengrassDataPlaneEndpoint: "iotdata"
greengrassDataPlanePort: 443

Validate you might be utilizing VPCe

To validate you might be utilizing the VPCe and never traversing the general public web, run the next command from the AWS IoT Greengrass core machine:

nslookup [the 'A' record created in Route53 for IoT Credential Endpoin]
nslookup [the 'A' record created in Route53 for IoT Data Enpoint]

The IP addresses returned by the above instructions must be within the vary of the subnets related together with your VPC endpoints.

Then, you may run the identical instructions out of your laptop computer. It is best to get public IPs for the endpoints.

AWS IoT units

After you’ve carried out the steps in part “Create VPC endpoints,” you can even use AWS IoT Core credential supplier via VPCe, immediately from AWS IoT Core issues operating in your VPC. To check this feature, comply with the following steps.

1. Comply with the step-by-step wizard within the console to create a single factor.

2. Comply with the Authorizing direct calls to AWS providers utilizing AWS IoT Core credential supplier documentation to create the required roles and insurance policies, and fasten them to the certificates created within the earlier step.

3. Transfer the connect_device_package.zip file created throughout the wizard execution into the machine the place you might be planning to make use of the AWS IoT System SDK. For testing this, you should utilize an Amazon EC2 occasion. In any case, verify the machine or EC2 occasion is linked to a community or subnet throughout the VPC the place the VPC endpoint was created. You’ll be able to validate this operating the next instructions from the machine or EC2 occasion.

nslookup [the 'A' record created in Route53 for IoT Credential Endpoin]
nslookup [the 'A' record created in Route53 for IoT Data Enpoint]

The IP addresses returned by the above instructions must be within the vary of the subnets related together with your VPCe endpoints.

4. Run the next CURL command from the Authorizing direct calls to AWS providers utilizing AWS IoT Core credential supplier documentation, pointing to the “A” file created in Amazon Route 53 within the credentials.iot.us-east-1.amazonaws.com personal zone. It’s going to appear to be your_aws_account_specific_prefix.credentials.iot.us-east-1.amazonaws.com

curl --cert your certificates --key your machine certificates key pair -H "x-amzn-iot-thingname: your factor title" --cacert AmazonRootCA1.pem https://your endpoint /role-aliases/your position alias/credentials

Conclusion

With the brand new VPCe assist for AWS IoT Core credential supplier, now you can have end-to-end VPC communication between units—both immediately via AWS IoT System SDKs or AWS IoT Greengrass—while not having to arrange community proxies and complicated firewall configurations. This simplified community infrastructure may also help you scale back operational overhead prices and enhance the safety posture of your answer. To be taught extra, go to AWS IoT Greengrass and interface VPC endpoints (AWS PrivateLink)

Concerning the authors

Vladi Salomon is a Principal IoT Knowledge Architect with Amazon Net Providers. He has 7+ years of expertise in IoT structure in numerous vertical like IIoT, Sensible Residence, Sensible Metropolis and Mining in addition to information warehousing and massive information platform. Within the newest years he acquired focus in learn how to carry AI to IoT via scalable MLOps platforms. As a member of AWS Skilled Providers, He works with clients of various scale and industries architecting and implementing quite a lot of end-to-end IoT options.

Victor Lesau is a Sr. Technical Product Supervisor at Amazon Net Providers. He focuses on product technique, roadmap planning, enterprise evaluation, buyer engagement, and different product administration areas of AWS IoT Core, AWS IoT Id, and good residence initiatives.

Ben Omer is a Sr. Technical Product Supervisor at Amazon Net Providers. He works with IoT machine providers and merchandise together with FreeRTOS, AWS IoT Greengrass, and KVS, with a concentrate on roadmap planning, characteristic exploration, and buyer engagement.