@openziti/ziti-sdk-nodejs 0.6.0

package/README.md

@@ -0,0 +1,155 @@
+<p align="center" width="100%">
+<a href="https://openziti.io"><img src="ziti.png" width="100"></a>
+</p>
+
+<p align="center">
+    <b>
+    <a>@openziti/ziti-sdk-nodejs</a>
+    <br>
+    <br>
+    <b>
+    A NodeJS-based SDK for delivering secure applications over a [Ziti Network](https://openziti.io)
+    <br>
+    <br>
+    <b>Part of the <a href="https://openziti.io/about">OpenZiti</a> ecosystem</b>
+</p>
+
+<p align="center">
+    <br>
+    <b>Are you interested in knowing how to easily embed programmable, high performance, zero trust networking into your NodeJS app, on any internet connection, without VPNs?
+    <br>
+    Learn more about our <a href="https://openziti.io/about">OpenZiti</a> project.</b>
+    <br>
+    </p>
+
+---
+[![Build Status](https://github.com/openziti/ziti-sdk-nodejs/workflows/Build/badge.svg?branch=main)]()
+[![Issues](https://img.shields.io/github/issues-raw/openziti/ziti-sdk-nodejs)]()
+[![npm version](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs.svg)](https://badge.fury.io/js/@openziti%2Fziti-sdk-nodejs)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![LOC](https://img.shields.io/tokei/lines/github/openziti/ziti-sdk-nodejs)]()
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=rounded)](CONTRIBUTING.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+---
+
+
+
+
+# Supported platforms
+
+The `ziti-sdk-nodejs` module works with Node.js v11.x, v12.x, v13.x, v14.x
+
+Binaries for most Node versions and platforms are provided by default via [node-pre-gyp](https://github.com/mapbox/node-pre-gyp).
+
+# Installing
+
+``` js
+npm i @openziti/ziti-sdk-nodejs
+```
+
+
+# Usage
+
+**Note:** the module must be [installed](#installing) before use.
+
+``` js
+var ziti = require('ziti-sdk-nodejs');
+
+const ziti_init = async (identity) => {
+    return new Promise((resolve) => {
+        ziti.ziti_init(identity, () => {
+            resolve();
+        });
+    });
+};
+
+const ziti_service_available = (service) => {
+    return new Promise((resolve) => {
+        ziti.ziti_service_available(service, (status) => {
+            resolve(status);
+        });
+    });
+};
+
+function ziti_dial(service) {
+    return new Promise((resolve, reject) => {
+        ziti.ziti_dial(
+            service,
+            (conn) => {
+                resolve(conn);
+            },
+            (data) => {
+                // Do something with data...
+            },
+        );
+    });
+}
+
+const ziti_write = (conn, data) => {
+    return new Promise((resolve) => {
+        ziti.ziti_write(conn, data, () => {
+            resolve();
+        });
+    });
+};
+
+(async () => {
+
+    await ziti_init(LOCATION_OF_IDENTITY_FILE);
+
+    let status = await ziti_service_available(YOUR_SERVICE_NAME);
+
+    if (status === 0) {
+
+        const conn = await ziti_dial(YOUR_SERVICE_NAME);
+
+        let data = SOME_KIND_OF_DATA;
+
+        let buffer = Buffer.from(data);
+
+        await ziti_write(conn, buffer);
+
+        ...etc
+    }
+
+})();
+```
+
+
+# Ziti NodeJS SDK - Setup for Development
+
+The following steps should get your NodeJS SDK for Ziti building. The Ziti NodeJS SDK is a native addon for Node JS,
+and is written in C. C development is specific to your operating system and tool chain used. These steps should work 
+properly for you but if your OS has variations you may need to adapt these steps accordingly.
+
+
+## Prerequisites
+
+### Build
+
+* [Cmake (3.12+)](https://cmake.org/install/)
+
+
+## Build
+
+### Linux/MacOS
+
+Building the NodeJS SDK on linux/mac can be accomplished with:
+
+```bash
+$ npm run build
+```
+
+
+Getting Help
+------------
+Please use these community resources for getting help. We use GitHub [issues](https://github.com/NetFoundry/ziti-sdk-nodejs/issues) 
+for tracking bugs and feature requests and have limited bandwidth to address them.
+
+- Read the [docs](https://netfoundry.github.io/ziti-doc/ziti/overview.html)
+- Join our [Developer Community](https://developer.netfoundry.io)
+- Participate in discussion on [Discourse](https://openziti.discourse.group/)
+
+
+Copyright&copy;  NetFoundry, Inc.

package/appveyor.yml-obsolete

@@ -0,0 +1,32 @@
+ platform:
+   - x64
+ 
+ configuration:
+   - Debug
+
+ image:
+   - Visual Studio 2019
+ 
+ environment:
+   AWS_ACCESS_KEY_ID:
+     secure: GIQzwkV21ZqWhzZ0ii13r4dOEZ6Pkq8r6Jajx18uEaY=
+   AWS_SECRET_ACCESS_KEY:
+     secure: 7sxn6236C/oltJYJfel3ISUxQfuBfB44QqdWs0Thjy+U3s+6MPugW8CGVlC8p0o8
+ 
+   matrix:
+    - nodejs_version: 11
+      platform: x64
+    - nodejs_version: 12
+      platform: x64
+    - nodejs_version: 13
+      platform: x64
+    - nodejs_version: 14
+      platform: x64
+  
+ install:
+   - scripts\build-appveyor.bat
+   - ps: if($env:appveyor_repo_tag -eq 'True') { npm run publish } else { echo "Not publishing binary because this is not a tag build" }
+ 
+ build: OFF
+ test: OFF
+ deploy: OFF

package/binding.gyp

@@ -0,0 +1,227 @@
+{
+  # "includes": [ "deps/common-ziti.gypi" ],
+
+  # The "cd" variable is passed in, and used, only during Windows builds
+  'variables': {
+    'cd%': '.',
+
+    # node v0.6.x doesn't give us its build variables,
+    # but on Unix it was only possible to use the system OpenSSL library,
+    # so default the variable to "true", v0.8.x node and up will overwrite it.
+    'node_shared_openssl%': 'true'
+
+	},
+
+  "targets": [
+    {
+      'defines': [
+        'BUILD_DATE=<@(BUILD_DATE)',
+        'ZITI_BRANCH=<@(ZITI_BRANCH)',
+        'ZITI_COMMIT=<@(ZITI_COMMIT)',
+        'ZITI_VERSION=<@(ZITI_VERSION)',
+        'ZITI_OS=<@(ZITI_OS)',
+        'ZITI_ARCH=<@(ZITI_ARCH)',
+      ],
+
+      "target_name": "<(module_name)",
+
+      "product_dir": "<(module_path)",
+
+      "sources": [ 
+        "./src/ziti-add-on.c",
+        "./src/ziti_close.c",
+        "./src/ziti_dial.c",
+        "./src/ziti_enroll.c",
+        "./src/ziti_hello.c",
+        "./src/Ziti_https_request.c",
+        "./src/Ziti_https_request_data.c",
+        "./src/Ziti_https_request_end.c",
+        "./src/ziti_init.c",
+        "./src/ziti_service_available.c",
+        "./src/ziti_shutdown.c",
+        "./src/ziti_write.c",
+        "./src/ziti_websocket_connect.c",
+        "./src/ziti_websocket_write.c",
+        # "./src/stack_traces.c",
+        "./src/utils.c",
+      ],
+
+      "include_dirs": [
+          "deps/ziti-sdk-c/includes",
+          "deps/ziti-sdk-c/build/_deps/uv-mbed-src/include",
+          "deps/ziti-sdk-c/build/_deps/http_parser-src",
+          "deps/ziti-sdk-c/build/_deps/uv_link-src/include",
+      ],
+
+      "conditions": [
+
+        ['node_shared_openssl=="false"', {
+          # so when "node_shared_openssl" is "false", then OpenSSL has been
+          # bundled into the node executable. So we need to include the same
+          # header files that were used when building node.
+          'include_dirs': [
+            '<(node_root_dir)/deps/openssl/openssl/include'
+          ],
+          "conditions" : [
+            ["target_arch=='ia32'", {
+              "include_dirs": [ "<(node_root_dir)/deps/openssl/config/piii" ]
+            }],
+            ["target_arch=='x64'", {
+              "include_dirs": [ "<(node_root_dir)/deps/openssl/config/k8" ]
+            }],
+            ["target_arch=='arm'", {
+              "include_dirs": [ "<(node_root_dir)/deps/openssl/config/arm" ]
+            }]
+          ]
+        }],
+
+        ["OS=='mac'", {
+
+          "libraries": [ 
+            "$(PWD)/deps/ziti-sdk-c/build/_deps/libuv-build/libuv_a.a",
+            "$(PWD)/deps/ziti-sdk-c/build/_deps/libsodium-build/lib/libsodium.a",
+            "$(PWD)/deps/ziti-sdk-c/build/_deps/uv-mbed-build/libuv_mbed.a",
+            "$(PWD)/deps/ziti-sdk-c/build/library/libziti.a",        
+
+
+            # These are used when a local Xcode debug build is in play
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/Debug/libhttp-parser.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/crypto/library/Debug/libmbedcrypto.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/library/Debug/libmbedtls.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/library/Debug/libmbedx509.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/libuv/Debug/libuv_a.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/Debug/libuv_link.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/deps/uv-mbed/Debug/libuv_mbed.a",
+            # "$(PWD)/deps/ziti-sdk-c/build/library/Debug/libziti.a",        
+
+          ],
+
+          "xcode_settings": {
+            "ALWAYS_SEARCH_USER_PATHS": "NO",
+            "GCC_CW_ASM_SYNTAX": "NO",                # No -fasm-blocks
+            "GCC_DYNAMIC_NO_PIC": "NO",               # No -mdynamic-no-pic
+                                                      # (Equivalent to -fPIC)
+            "GCC_ENABLE_CPP_EXCEPTIONS": "NO",        # -fno-exceptions
+            "GCC_ENABLE_CPP_RTTI": "NO",              # -fno-rtti
+            "GCC_ENABLE_PASCAL_STRINGS": "NO",        # No -mpascal-strings
+            "GCC_THREADSAFE_STATICS": "NO",           # -fno-threadsafe-statics
+            "PREBINDING": "NO",                       # No -Wl,-prebind
+            "MACOSX_DEPLOYMENT_TARGET": "10.15",      # -mmacosx-version-min=10.14
+            "USE_HEADERMAP": "NO",
+            "OTHER_CFLAGS": [
+              "-fno-strict-aliasing",
+              "-g",
+              "-fno-pie",
+              "-DSOURCE_PATH_SIZE=3"
+            ],
+            "OTHER_LDFLAGS": [
+              "-g",
+              "-mmacosx-version-min=10.15",
+            ],
+            "WARNING_CFLAGS": [
+              "-Wall",
+              "-Wendif-labels",
+              "-W",
+              "-Wno-unused-parameter",
+              "-Wno-pointer-sign",
+              "-Wno-unused-function",
+            ],
+          }
+        }],
+
+
+        ['OS == "win"', {
+
+          'defines': [
+            'WIN32',
+            # we don't really want VC++ warning us about
+            # how dangerous C functions are...
+            '_CRT_SECURE_NO_DEPRECATE',
+            # ... or that C implementations shouldn't use
+            # POSIX names
+            '_CRT_NONSTDC_NO_DEPRECATE',
+            #
+            'NOGDI',
+            'DSOURCE_PATH_SIZE=3'
+          ],
+
+          "include_dirs": [ 
+            "deps/ziti-sdk-c/includes",
+            "deps/ziti-sdk-c/deps/uv-mbed/include"
+          ],
+          "libraries": [
+            # "<(cd)/deps/ziti-sdk-c/build/_deps/mbedtls-build/library/mbedcrypto.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/_deps/mbedtls-build/library/mbedtls.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/_deps/mbedtls-build/library/mbedx509.lib",
+            "<(cd)/deps/ziti-sdk-c/build/_deps/libuv-build/uv_a.lib",
+            "<(cd)/deps/ziti-sdk-c/build/_deps/libsodium-src/x64/Release/v142/static/libsodium.lib",
+            "<(cd)/deps/ziti-sdk-c/build/_deps/uv-mbed-build/uv_mbed.lib",
+            "<(cd)/deps/ziti-sdk-c/build/library/ziti.lib",
+
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/http-parser.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/crypto/library/mbedcrypto.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/library/mbedtls.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/mbedtls/library/mbedx509.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/libuv/uv_a.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/deps/uv_link.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/deps/uv-mbed/uv_mbed.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/library/ziti.lib",
+            # "<(cd)/deps/ziti-sdk-c/build/_deps/libsodium-src/x64/Release/v142/static/libsodium.lib",
+            "-lws2_32.lib",
+            "-lIphlpapi.lib",
+            "-lpsapi",
+            "-luserenv.lib"
+          ],
+
+          'msvs_settings': {
+            'VCCLCompilerTool': {
+              'RuntimeLibrary': 1, # static debug
+              'Optimization': 0, # /Od, no optimization
+            },
+            'VCLinkerTool': {
+              'AdditionalOptions': [
+                '/FORCE'
+              ],
+              'LinkTimeCodeGeneration': 1, # link-time code generation
+              'GenerateDebugInformation': 'true',
+              'IgnoreDefaultLibraryNames': [
+                'libcmtd.lib', 'libcmt.lib', 'msvcrtd.lib'
+              ],
+              'SubSystem': 1, # /subsystem:console
+            }
+          },
+
+        }],
+
+
+        ['OS == "linux"', {
+
+          "libraries": [
+            "<(module_root_dir)/deps/ziti-sdk-c/build/library/libziti.a",        
+            "<(module_root_dir)/deps/ziti-sdk-c/build/_deps/libuv-build/libuv_a.a",
+            "<(module_root_dir)/deps/ziti-sdk-c/build/_deps/uv-mbed-build/libuv_mbed.a",
+            "<(module_root_dir)/deps/ziti-sdk-c/build/_deps/libsodium-build/lib/libsodium.a",
+          ],
+
+          "link_settings": {
+            "ldflags": [
+              "-v",
+               "-g",
+            ]
+          },
+
+          "cflags": [
+            "-fno-strict-aliasing",
+            "-g",
+            "-fno-pie",
+            "-fPIC",
+            "-DSOURCE_PATH_SIZE=3"
+          ]
+
+        }]
+
+      ]
+
+    }
+  ]
+}

package/lib/index.js

@@ -0,0 +1,17 @@
+/*
+Copyright 2019-2020 Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+module.exports = require('./ziti');

package/lib/ziti.js

@@ -0,0 +1,40 @@
+/*
+Copyright 2019-2020 Netfoundry, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+var binding;
+
+function importAll (r) {
+  r.keys().forEach(key => {
+    console.log('importAll() addon key is: ', key);
+    binding = r(key); // Load the addon
+  });
+}
+
+if (typeof require.context == 'function') {
+
+    importAll( require.context("../build/", true, /\.node$/) );
+
+} else {
+
+    const binary = require('@mapbox/node-pre-gyp');
+    const path = require('path')
+    const binding_path = binary.find(path.resolve(path.join(__dirname,'../package.json')), {debug: false});
+
+    binding = require(binding_path);
+    
+}
+
+var ziti = module.exports = exports = binding;

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@openziti/ziti-sdk-nodejs",
+  "description": "A NodeJS-based SDK for delivering secure applications over a Ziti Network",
+  "version": "0.6.0",
+  "main": "./lib/ziti",
+  "scripts": {
+    "build": "npm run build:init; npm run build:c-sdk; npm install --build-from-source --clang=1",
+    "build:init": "git submodule update --init --recursive",
+    "build:c-sdk": "cd deps/ziti-sdk-c; git submodule update --init --recursive; mkdir build; cd build; cmake -G Ninja -DCMAKE_POSITION_INDEPENDENT_CODE=ON --config Debug ..; cmake --build . --target all",
+    "build:nodejs": "node-gyp clean configure --debug build --debug -g --mmacosx-version-min=10.13",
+    "build:nodejsdbg": "npm install --build-from-source --debug -g",
+    "build:cleanup": "cd deps/ziti-sdk-c && rm -rf build",
+    "clean": "node-gyp clean; rm -rf build; cd deps/ziti-sdk-c && rm -rf build",
+    "test": "echo \"Error: no test specified\"",
+    "configure": "node-gyp configure --debug",
+    "start": "node main.js ./config/identity.json chapel-hill",
+    "install": "node-pre-gyp install --fallback-to-build",
+    "install-dbg": "npm install --build-from-source --clang=1 --debug",
+    "publish": "node-pre-gyp package publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/netfoundry/ziti-sdk-nodejs.git"
+  },
+  "binary": {
+    "module_name": "ziti_sdk_nodejs",
+    "module_path": "./build/{configuration}/{node_abi}-{platform}-{arch}/",
+    "remote_path": "./{module_name}/v{version}/{configuration}/",
+    "package_name": "{module_name}-v{version}-{node_abi}-{platform}-{arch}.tar.gz",
+    "host": "https://ziti-npm.s3.amazonaws.com"
+  },
+  "license": "Apache-2.0",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
+  "keywords": [
+    "ziti",
+    "nodejs"
+  ],
+  "engines": {
+    "node": ">=11.0.0"
+  },
+  "author": {
+    "name": "NetFoundry",
+    "url": "http://netfoundry.io"
+  },
+  "devDependencies": {
+    "aws-sdk": "^2.823.0"
+  },
+  "dependencies": {
+    "@mapbox/node-pre-gyp": "^1.0.8"
+  }
+}