@itentialopensource/adapter-paragon_iam 0.2.3 → 0.3.0

package/TAB2.md

@@ -0,0 +1,377 @@
+# Paragon IAM
+
+## 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 Paragon IAM adapter with Multi Step 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>. 
+
+#### Multi Step Authentication
+The Paragon IAM adapter requires Multi Step 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 Paragon 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": "multi_step_authentication",
+  "token_timeout": 1800000,
+  "token_cache": "local",
+  "invalid_token_error": 401,
+  "auth_field": "header.headers.x-iam-token",
+  "auth_field_format": "{tokenp2}",
+  "auth_logging": false,
+  "multiStepAuthCalls": [
+    {
+      "name": "getFirstToken",
+      "requestFields": {
+        "user": {
+          "domain": "",
+          "name": ""
+        },
+        "password": "",
+        "methods": [
+          "PASSWORD"
+        ]
+      },
+      "responseFields": {
+        "firstIdToken": "id_token",
+        "scopeId": "scopes.0.id"
+      },
+      "successfullResponseCode": 200
+    },
+    {
+      "name": "getSecondToken",
+      "requestFields": {
+        "token": "{getFirstToken.responseFields.firstIdToken}",
+        "scopeId": "{getFirstToken.responseFields.scopeId}",
+        "methods": [
+          "TOKEN"
+        ]
+      },
+      "responseFields": {
+        "tokenp2": "id_token"
+      },
+      "successfullResponseCode": 200
+    }
+  ]
+}
+```
+you can leave all of the other properties in the authentication section, they will not be used when the auth_method is multi_step_authentication. <br>
+4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+
+#### Troubleshooting
+- Make sure you copied over the correct username and password.
+- 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.
+
+### 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": "localhost",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "multi_step_authentication",
+      "username": "admin",
+      "password": "pass",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.x-iam-token",
+      "auth_field_format": "{tokenp2}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "getFirstToken",
+          "requestFields": {
+            "user": {
+              "domain": "",
+              "name": ""
+            },
+            "password": "",
+            "methods": [
+              "PASSWORD"
+            ]
+          },
+          "responseFields": {
+            "firstIdToken": "id_token",
+            "scopeId": "scopes.0.id"
+          },
+          "successfullResponseCode": 200
+        },
+        {
+          "name": "getSecondToken",
+          "requestFields": {
+            "token": "{getFirstToken.responseFields.firstIdToken}",
+            "scopeId": "{getFirstToken.responseFields.scopeId}",
+            "methods": [
+              "TOKEN"
+            ]
+          },
+          "responseFields": {
+            "tokenp2": "id_token"
+          },
+          "successfullResponseCode": 200
+        }
+      ]
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {},
+      "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": false,
+      "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/security/adapter-paragon_iam/-/blob/master/report/adapter-openapi.json) 
+
+## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/security/adapter-paragon_iam/-/blob/master/README.md) 
+

package/entities/.system/action.json

@@ -25,6 +25,46 @@
         }
       ]
     },
+    {
+      "name": "MFA_Step_1",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/iam/authenticate",
+      "requestSchema": "schemaTokenReq_MFA_Step_1.json",
+      "responseSchema": "schemaTokenResp_MFA_Step_1.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/MFA_Step_1-default.json"
+        }
+      ]
+    },
+    {
+      "name": "MFA_Step_2",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/iam/authenticate",
+      "requestSchema": "schemaTokenReq_MFA_Step_2.json",
+      "responseSchema": "schemaTokenResp_MFA_Step_2.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/MFA_Step_2-default.json"
+        }
+      ]
+    },
     {
       "name": "healthcheck",
       "protocol": "REST",

package/entities/.system/mockdatafiles/MFA_Step_1-default.json

@@ -0,0 +1,31 @@
+{
+  "status": "AUTHENTICATED",
+  "user_id": "string",
+  "id_token": "eyJh",
+  "token": {
+    "user_id": "string",
+    "user_name": "admin",
+    "iat": "string",
+    "exp": "string",
+    "unique_identifier": "string",
+    "identity_provider_type": "Local"
+  },
+  "scopes": [
+    {
+      "id": "string",
+      "name": "default",
+      "display_name": "default",
+      "type": "string"
+    },
+    {
+      "id": "string",
+      "name": "string",
+      "display_name": "string",
+      "type": "Tenant",
+      "parent_id": "string",
+      "parent_name": "default",
+      "parent_type": "string"
+    }
+  ],
+  "identity_provider_type": "Local"
+}

package/entities/.system/mockdatafiles/MFA_Step_2-default.json

@@ -0,0 +1,107 @@
+{
+  "status": "AUTHENTICATED",
+  "user_id": "string",
+  "id_token": "eyJhbGc",
+  "token": {
+    "user_id": "string",
+    "user_name": "admin",
+    "iat": "string",
+    "exp": "string",
+    "roles": [
+      {
+        "id": "string",
+        "name": "string",
+        "type": "string",
+        "predefined": true
+      }
+    ],
+    "intents": [],
+    "scope": {
+      "id": "string",
+      "name": "default",
+      "type": "string",
+      "display_name": "default"
+    },
+    "capabilities": [
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      },
+      {
+        "service": "string",
+        "methods": []
+      }
+    ],
+    "unique_identifier": "string",
+    "identity_provider_type": "Local"
+  },
+  "identity_provider_type": "Local"
+}

package/entities/.system/schemaTokenReq.json

@@ -23,7 +23,7 @@
         "type": "AES",
         "key": ""
       },
-      "external_name": "username"
+      "external_name": "userName"
     },
     "password": {
       "type": "string",

package/entities/.system/schemaTokenReq_MFA_Step_1.json

@@ -0,0 +1,19 @@
+{
+    "$id": ".system-schemaTokenReq_MFA_Step_1.json",
+    "type": "object",
+    "schema": "http://json-schema.org/draft-07/schema#",
+    "translate": true,
+    "dynamicfields": true,
+    "properties": {
+      "ph_request_type": {
+        "type": "string",
+        "description": "type of request (internal to adapter)",
+        "default": "MFA_Step_1",
+        "enum": [
+          "MFA_Step_1"
+        ],
+        "external_name": "ph_request_type"
+      }
+    },
+    "definitions": {}
+  }

package/entities/.system/schemaTokenReq_MFA_Step_2.json

@@ -0,0 +1,24 @@
+{
+    "$id": ".system-schemaTokenReq_MFA_Step_2.json",
+    "type": "object",
+    "schema": "http://json-schema.org/draft-07/schema#",
+    "translate": true,
+    "dynamicfields": true,
+    "properties": {
+      "ph_request_type": {
+        "type": "string",
+        "description": "type of request (internal to adapter)",
+        "default": "MFA_Step_2",
+        "enum": [
+          "MFA_Step_2"
+        ],
+        "external_name": "ph_request_type"
+      },
+      "scopeId": {
+        "type": "string",
+        "description": "scopeId",
+        "external_name": "scope_id"
+      }
+    },
+    "definitions": {}
+  }

package/entities/.system/schemaTokenResp_MFA_Step_1.json

@@ -0,0 +1,38 @@
+{
+  "$id": ".system-schemaTokenResp_MFA_Step_1.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": false,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "MFA_Step_1",
+      "enum": [
+        "MFA_Step_1"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "token": {
+      "description": "token returned by system",
+      "parse": false,
+      "encode": false,
+      "placement": "BODY",
+      "external_name": "id_token"
+    },
+    "tokenp2": {
+      "description": "token returned by system",
+      "parse": false,
+      "encode": false,
+      "placement": "BODY",
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "scopes.0.id"
+    }
+
+  },
+  "definitions": {}
+}

package/entities/.system/schemaTokenResp_MFA_Step_2.json

@@ -0,0 +1,33 @@
+{
+    "$id": ".system-schemaTokenResp_MFA_Step_2.json",
+    "type": "object",
+    "schema": "http://json-schema.org/draft-07/schema#",
+    "translate": true,
+    "dynamicfields": true,
+    "properties": {
+      "ph_request_type": {
+        "type": "string",
+        "description": "type of request (internal to adapter)",
+        "default": "MFA_Step_2",
+        "enum": [
+          "MFA_Step_2"
+        ],
+        "external_name": "ph_request_type"
+      },
+      "token": {
+        "description": "token returned by system",
+        "parse": false,
+        "encode": false,
+        "placement": "BODY",
+        "external_name": "token"
+      },
+      "tokenp2": {
+        "description": "token returned by system",
+        "parse": false,
+        "encode": false,
+        "placement": "BODY",
+        "external_name": "id_token"
+      }
+    },
+    "definitions": {}
+  }