@itentialopensource/adapter-aws_cloudformation 0.2.9 → 0.3.0

package/TAB2.md

@@ -0,0 +1,379 @@
+# AWS CloudFormation
+
+## Table of Contents 
+
+  - [Specific Adapter Information](#specific-adapter-information) 
+    - [Authentication](#authentication) 
+    - [Sample Properties](#sample-properties) 
+    - [Swagger](#swagger) 
+  - [Generic Adapter Information](#generic-adapter-information) 
+
+## Specific Adapter Information
+### Authentication
+
+This document will go through the steps for authenticating the AWS CloudFormation adapter with AWS Signature 4 Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+
+#### AWS Authentication
+The AWS CloudFormation adapter requires AWS Authentication, therefore the `auth_method` should be set to `aws_authentication`. The adapter utilizes AWS signature 4 authentication. There are three mechanisms for doing this. 
+
+The first way is using a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below.
+
+The second way is using AWS STS. this still requires a "service" account and its AWS keys to authenticate as that account. In this case, you will get the aws_access_key, aws_secret_key, and aws_session_token from AWS and configure them into the adapter service instance as shown below. In addition, you will provide STS paramaters in the workflow tasks that tell the adapter the role you want used on the particular call. 
+
+The third authentication method is to use an IAM role. With this method, you do not need any authentication keys as the adapter will utilize an "internal" AWS call to get the things that it needs for authentication. Since the adapter needs to make the call to this "internal" AWS IP address, the IAP server needs to be where it has access to that address or you will not be able to use this method.
+
+If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+#### AWS Signature 4 Service Account Authentication
+The AWS CloudFormation adapter requires AWS Signature 4 Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+
+STEPS  
+1. Ensure you have access to a AWS CloudFormation server and that it is running
+2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+3. Use the properties below for the ```properties.authentication``` field
+```json
+"authentication": {
+  "auth_method": "aws_authentication",
+  "aws_access_key": "aws_access_key",
+  "aws_secret_key": "aws_secret_key",
+  "aws_session_token": "aws_session_token"
+}
+```
+you can leave all of the other properties in the authentication section, they will not be used for AWS CloudFormation authentication.
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+#### AWS Security Token Service
+The AWS CloudFormation adapter also supports AWS Security Token Service (STS) Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and pass the STS information into the method. You will still need to provide the relevant `aws_secret_key` and `aws_access_key` as described above. Below is an example of the data required in the `sts` tasks. The data provided below will enable the adapter to switch to `my_role` in order to make the call to CloudFormation:
+
+```json
+{
+  "RoleArn": "arn:aws:iam::1234567:role/my_role",
+  "RoleSessionName": "mySession"
+}
+```
+
+#### AWS IAM Role
+The AWS CloudFormation adapter also supports AWS IAM Role Authentication. For using this authentication, you need to use the calls in the Adapter that have the STSRole suffix on them and provide the role's ARN in the RoleName variable. In addition to passing the IAM Role in the task, it is possible to set an IAM Role in the Service Instance Configuration by using the `aws_iam_role` property in the authentication section and providing the role's ARN.
+
+```json
+"authentication": {
+  "auth_method": "aws_authentication",
+  "aws_iam_role": "role_arn"
+}
+```
+
+#### AMAZON STEPS FOR IAM ROLE
+Increase number of hops if running IAP inside of docker on EC2 instance
+```bash
+aws sso login --profile aws-bota-1
+<export aws keys for CLI access>
+
+AWS ec2 modify-instance-metadata-options  --instance-id i-0e150236026b7c45d  --http-put-response-hop-limit 3 --http-endpoint enabled --region us-east-1
+```
+
+Create a new role and attach to it policies:
+- go to your EC2 instance, select it
+- Actions->Security->Modify IAM Role
+- Click 'Create New IAM Role'
+- Create a role:
+```text
+Trusted entity type: AWS service
+Use Case: EC2
+```
+
+Add desired policies to the role. 
+
+Save the role
+
+Go back to your EC2 instance and Actions->Security->Modify IAM Role, associate newly created role with your EC2 instance
+
+#### Troubleshooting
+- Make sure you copied over the correct access key, secret key and session token.
+- Turn on debug level logs for the adapter in IAP Admin Essentials.
+- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
+- Investigate the logs - in particular:
+  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
+  - The FULL BODY log to make sure the payload is accurate.
+  - The CALL RETURN log to see what the other system is telling us.
+- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
+- Remember when you are done to turn auth_logging off as you do not want to log credentials.
+- For IAM, you can run this on the IAP server to verify you are getting to the "internal" AWS Server
+```bash
+TOKEN=`curl -v -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600"` && curl -v -H "X-aws-ec2-metadata-token: $TOKEN" -v http://169.254.169.254/latest/meta-data/iam/security-credentials/<rolename>
+```
+### Sample Properties
+
+Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
+
+```json
+  "properties": {
+    "host": "cloudformation.us-east-1.amazonaws.com",
+    "region": "us-east-1",
+    "port": 443,
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": true,
+    "stub": true,
+    "protocol": "https",
+    "service": "cloudformation",
+    "authentication": {
+      "auth_method": "aws_authentication",
+      "username": "username",
+      "password": "password",
+      "token": "",
+      "token_timeout": 180000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Cookie",
+      "auth_field_format": "Token {token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ],
+      "aws_access_key": "aws_access_key",
+      "aws_secret_key": "aws_secret_key",
+      "aws_session_token": "aws_session_token",
+      "aws_iam_role": ""
+    },
+    "healthcheck": {
+      "type": "startup",
+      "frequency": 60000,
+      "query_object": {
+        "Action": "ListExports",
+        "Version": "2010-05-15"
+      },
+      "addlHeaders": {}
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": 0,
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {},
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": true,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "enabled": false,
+      "getDevice": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "insample": "{port}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial": "{serial}",
+            "id": "{myid}"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "return2xx",
+            "statusValue": "AD.200"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/not/mapped/{devID}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "devID": "{id}"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/not/mapped",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 10000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/not/mapped",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial": "{serial}",
+                "id": "{myid}"
+              }
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
+    }
+  }
+```
+### [Swagger](https://gitlab.com/itentialopensource/adapters/cloud/adapter-aws_cloudformation/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/cloud/adapter-aws_cloudformation/-/blob/master/README.md) 
+

package/metadata.json

@@ -42,20 +42,37 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "AWS Auth",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-aws_cloudformation",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-aws_cloudformation",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-aws_cloudformation",
     "docLink": "https://docs.itential.com/opensource/docs/amazon-aws-cloud-formation",
     "demoLinks": [],
-    "trainingLinks": [],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
     "webLink": "https://www.itential.com/adapters/aws-cloud-formation/",
     "vendorLink": "https://aws.amazon.com/",
-    "productLink": "",
-    "apiLinks": []
+    "productLink": "https://aws.amazon.com/cloudformation/",
+    "apiLinks": [
+      {
+        "title": "AWS CloudFormation API Documentation",
+        "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/Welcome.html",
+        "public": true
+      }
+    ]
   },
   "relatedItems": {
     "adapters": [],

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-aws_cloudformation",
-  "version": "0.2.9",
+  "version": "0.3.0",
   "description": "This adapter integrates with system described as: Aws_cloudformation.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.10",
+  "engineVersion": "1.67.20",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -15,7 +15,6 @@
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -45,21 +44,21 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/cloud/adapter-aws_cloudformation.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-aws_cloudformation.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-aws_cloudformation#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-aws_cloudformation#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.3.8",
+    "@itentialopensource/adapter-utils": "^5.5.0",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "aws4": "^1.9.0",
-    "axios": "^1.6.7",
+    "axios": "^1.6.8",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",
@@ -67,7 +66,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/propertiesSchema.json

@@ -969,6 +969,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.4",
-  "configLines": 13218,
+  "version": "0.2.10",
+  "configLines": 13223,
   "scriptLines": 1783,
   "codeLines": 11578,
-  "testLines": 7183,
+  "testLines": 7182,
   "testCases": 345,
-  "totalCodeLines": 20544,
+  "totalCodeLines": 20543,
   "wfTasks": 163
 }

package/report/updateReport1717535381614.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.5.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 81
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 3355
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 197
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 2575
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 78
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 7383
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 275
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}