First commit

Signed-off-by: Francesco Vigo <fvigo@paloaltonetworks.com>

Author: fvigo

lib/credentials.ts

@@ -0,0 +1,83 @@
+import fetch from 'node-fetch';
+
+// This interface represents AppFramework token data
+export interface appFrameworkTokens {
+    accessToken?: string, // access token
+    refreshToken?: string, // refresh token
+}
+
+// constant URLs, can be overridden
+
+const IDP_TOKEN_URL: string = 'https://api.paloaltonetworks.com/api/oauth2/RequestToken'
+const IDP_REVOKE_URL: string = 'https://api.paloaltonetworks.com/api/oauth2/RevokeToken'
+const IDP_BASE_URL: string = 'https://identity.paloaltonetworks.com/as/authorization.oauth2'
+
+
+export class Credentials {
+    private access_token: string
+    private refresh_token: string
+    private client_id: string
+    private client_secret: string
+    private idp_token_url: string
+    private code: string
+    // TODO: region, instance_id, redirect_uri, scope, token_revoke_url, base_url, etc
+
+    constructor(client_id: string, client_secret: string, refresh_token?: string, code?: string, idp_token_url?: string) {
+        if(!refresh_token && !code) throw(`PanCloudError() Invalid Credentials (code or refresh token missing)`)
+        this.client_id = client_id
+        this.client_secret = client_secret
+        this.refresh_token = refresh_token || undefined
+        this.idp_token_url = idp_token_url || IDP_TOKEN_URL
+        this.code = code || undefined
+        //console.log('this idp =', this.idp_token_url)
+    }
+
+    public get_access_token(): string {
+        return this.access_token;
+    }
+
+    // version 3.0 with async/await
+    public async fetch_tokens(): Promise<appFrameworkTokens> {
+        let res = await fetch(this.idp_token_url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json'   
+            },
+            body: JSON.stringify({
+                "client_id": this.client_id,
+                "client_secret": this.client_secret,
+                "refresh_token": this.refresh_token || undefined,
+                "code": this.code || undefined
+            })
+        })
+        // console.log('debug:', JSON.stringify({
+        //     "client_id": this.client_id, 
+        //     "client_secret": this.client_secret,
+        //     "refresh_token": this.refresh_token || undefined,
+        //     "code": this.code || undefined
+        // }))
+        if (res.ok !== true && res.size === 0)
+            throw(`PanCloudError() ${res.status} ${res.statusText}`)
+
+        try {
+            let r_json = await res.json()
+            if (r_json.error || r_json.error_description) 
+                throw (`PanCloudError(): ` + await res.text())
+            let ret: appFrameworkTokens = {
+                accessToken: r_json.access_token
+            }
+            this.access_token = r_json.access_token
+            
+            if(r_json.refresh_token) { // a new refresh token is returned
+                this.refresh_token = r_json.refresh_token
+                ret.refreshToken = r_json.refresh_token
+            }
+            //ret.refreshToken = 'test_refresh_token' // TODO: remove this
+            console.log('Credentials(): Authorization token successfully retrieved')
+            return ret
+        } catch (exception) {
+            throw (`PanCloudError() Invalid JSON: ${exception}`)
+        }
+    }
+};

lib/exceptions.ts

@@ -0,0 +1,8 @@
+export class PanCloudError {
+    
+    private message: string
+
+    constructor(message: string) {
+        this.message = message
+    }
+}

lib/index.ts

@@ -0,0 +1,3 @@
+import { Credentials } from './credentials'
+import { LoggingService } from './loggingservice'
+export { Credentials, LoggingService }

lib/loggingservice.ts

@@ -0,0 +1,72 @@
+// Logging Service
+
+import fetch from 'node-fetch';
+
+const LS_QUERY_BASE_URL: string = "https://api.us.paloaltonetworks.com/logging-service/v1/queries"
+
+export class LoggingService {
+
+    private url: string;
+    private auth_token: string;
+
+    // Initialize 
+    constructor(url?: string, auth_token?: string) {
+        this.url = url ? url : LS_QUERY_BASE_URL
+        this.auth_token = auth_token ? auth_token : undefined
+
+    };
+
+    public set_auth_token(auth_token: string) { this.auth_token = auth_token };
+    public get_auth_token(): string { return this.auth_token };
+
+    public async create_query(startTime: number, endTime: number, maxWaitTime: number, sql: string):Promise <any> {
+        let url: string = this.url; // .bind(this)); // TODO: is bind(this) a better way to do it?
+        let auth_token = this.auth_token
+        let res = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': 'Bearer ' + auth_token
+            },
+            body: JSON.stringify({
+                "startTime": startTime, 
+                "endTime": endTime,
+                "maxWaitTime": maxWaitTime, 
+                "query": sql 
+            }),
+        });
+
+        if (res.ok === false)
+            throw(`PanCloudError() ${res.status} ${res.statusText}`)
+    
+        try {
+            let r_json = await res.json()
+            return r_json
+        } catch (exception) {
+            throw (`PanCloudError() Invalid JSON: ${exception}`)
+        }
+    };
+
+    public async poll(queryId: string, index: number): Promise <any> {
+        let url: string = `${this.url}/${queryId}/${index}`
+        let auth_token = this.auth_token
+        console.log('poll(): url is: ', url)
+        console.log('poll(): queryId is :', queryId)
+        let res = await fetch(url, {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': 'Bearer ' + auth_token
+            }
+        })
+        if (res.ok === false)
+            throw(`PanCloudError() ${res.status} ${res.statusText}`)
+
+        try {
+            let r_json = await res.json()
+            return r_json
+        } catch (exception) {
+            throw (`PanCloudError() Invalid JSON: ${exception}`)
+        }
+    }
+}

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "pancloud-nodejs",
+  "version": "1.0.0",
+  "description": "Palo Alto Networks Application Framework NodeJS SDK",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PaloAltoNetworks/pancloud-nodejs.git"
+  },
+  "keywords": [
+    "pancloud",
+    "nodejs",
+    "applicationframework"
+  ],
+  "author": "Palo Alto Networks",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/PaloAltoNetworks/pancloud-nodejs/issues"
+  },
+  "homepage": "https://github.com/PaloAltoNetworks/pancloud-nodejs#readme"
+}