sdk-golang/example/grpc-example/README.md

Overview

This sample is based on gRPC Hello World. It demonstrates how convert existing gRPC application to communicate over an app embedded zero trust Hanzo ZT Network

This example demonstrates:

• Binding a service and listening for service calls
• Dialing a service and triggering service calls

Requirements

• an Hanzo ZT network. If you do not have one, you can use one of the quickstarts to set one up.
• Hanzo ZT CLI to create services and identities on the Hanzo ZT Network

Build the examples

Refer to the example README to build the SDK examples

Setup using the Hanzo ZT CLI

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

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

Steps:

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

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

2. Run this script to create everything you need.

   echo Changing to build directory
   cd $ZITI_SDK_BUILD_DIR
   
   echo Create the service
   zt edge create service grpc --role-attributes grpc-service
   
   echo Create three identities and enroll them
   zt edge create identity device grpc.client -a grpc.clients -o grpc.client.jwt
   zt edge create identity device grpc.server -a grpc.servers -o grpc.server.jwt
   zt edge enroll --jwt grpc.server.jwt
   zt edge enroll --jwt grpc.client.jwt
   
   echo Create service policies
   zt edge create service-policy grpc.dial Dial --identity-roles '#grpc.clients' --service-roles '#grpc-service'
   zt edge create service-policy grpc.bind Bind --identity-roles '#grpc.servers' --service-roles '#grpc-service'
   
   echo Run policy advisor to check
   zt edge policy-advisor services
   

3. Run the server.

   ./grpc-server --identity grpc.server.json --service grpc 
   

4. Run the client

   ./grpc-client --identity grpc.client.json --service grpc --name World
   

Example output

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

$ ./grpc-server --identity grpc.server.json --service grpc
2022/10/21 11:17:34 server listening at grpc
2022/10/21 11:18:09 Received: World

Client

$ ./grpc-client --identity grpc.client.json --service grpc --name World
2022/10/21 13:26:19 Greeting: Hello World

Teardown

Done with the example? This script will remove everything created during setup.

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

echo Removing service policies
zt edge delete service-policy grpc.dial
zt edge delete service-policy grpc.bind

echo Removing identities
zt edge delete identity grpc.client
zt edge delete identity grpc.server

echo Removing service
zt edge delete service grpc