simple-server

README

Overview

This example illustrates how to embed zero trust connectivity into your server-side code. The server now listens on the OpenZiti overlay network and not on the layer 3, IP-based network.

This example demonstrates:

• Binding a service and listening for HTTP connections
• Accessing the service via a tunneler

Requirements

• an OpenZiti network. If you do not have one, you can use one of the quickstarts to set one up.
• OpenZiti CLI to create services and identities on the OpenZiti Network
• Have the appropriate Ziti Desktop Edge for your operating system

Build the examples

Refer to the example README to build the SDK examples

Setup using the OpenZiti CLI

These steps will configure the service using the OpenZiti CLI. At the end of these steps you will have created:

• a service called simpleService
• an identity to host (bind) the service
• an identity to connect to (dial) the service
• the service configs to connect the service to the overlay
• the service policies required to authorize the identities for bind and dial

Steps:

1. Log into OpenZiti. The host:port and username/password will vary depending on your network.

   ziti edge login localhost:1280 -u admin -p admin
   

2. Run this script to create everything you need.

   cd <repo-root-dir>/example/build
   
   echo Create the service configs
   ziti edge create config simple.hostv1 host.v1 '{"protocol":"tcp", "address":"localhost","port":'8080'}'
   ziti edge create config simple.interceptv1 intercept.v1 '{"protocols":["tcp"],"addresses":["simpleService.ziti"], "portRanges":[{"low":'8080', "high":'8080'}]}'
   
   echo Create the service
   ziti edge create service simpleService --configs "simple.hostv1,simple.interceptv1" --role-attributes simple-service
   
   echo Create two identities and enroll the server
   ziti edge create identity user simple-client -a simpleserver.clients -o simple-client.jwt
   ziti edge create identity device simple-server -a simpleserver.servers -o simple-server.jwt
   ziti edge enroll --jwt simple-server.jwt
   
   echo Create service policies
   ziti edge create service-policy simple-client-dial Dial --identity-roles '#simpleserver.clients' --service-roles '#simple-service'
   ziti edge create service-policy simple-client-bind Bind --identity-roles '#simpleserver.servers' --service-roles '#simple-service'
   
   echo Run policy advisor to check
   ziti edge policy-advisor services
   

3. Run the server.

   ./simple-server simple-server.json simpleService
   

4. Enroll the simple-client client identity

   1. Refer to enrolling documentation for details

5. Issue cURL commands to see the server side responses in action. There are two servers spun up by the simple-server binary. One server is a simple HTTP server which is running on the local machine. The second server is a zitified HTTP server, this server should be accessible from the device running ZDE where you enrolled the simple-client identity.

   # curl to the server listening on the underlay:
   curl http://localhost:8080?name=client
   
   # curl to the server listening on the overlay:
   curl http://simpleService.ziti:8080?name=client
   

Example output

The following is the output you'll see from the server and client side after running the previous commands. Server

$ ./simple-server simple-server.json simpleService
listening for non-ziti requests on localhost:8080
listening for requests for Ziti service simpleService
Saying hello to client, coming in from plain-internet
Saying hello to client, coming in from ziti

Client

$ curl http://localhost:8080?name=client
Hello, client, from plain-internet

$ curl http://simpleService.ziti:8080?name=client
Hello, client, from ziti

Teardown

Done with the example? This script will remove everything created during setup. You will have to manually remove the identity from your Ziti Desktop Edge application.

ziti edge login localhost:1280 -u admin -p admin

echo Removing service policies
ziti edge delete service-policy simple-client-dial
ziti edge delete service-policy simple-client-bind

echo Removing service configs
ziti edge delete config simple.hostv1
ziti edge delete config simple.interceptv1

echo Removing identities
ziti edge delete identity simple-client
ziti edge delete identity simple-server

echo Removing service
ziti edge delete service simpleService