History

Eric Anderson 6a50a63ca8 Replace javax.annotation-api with Tomcat's annotations-api javax.annotation-api is licensed CDDL, which was not noticed when it was introduced. Tomcat provides an Apache 2 version of the same annotation. Note that this annotation is only used when compiling with Java 9+. Unfortunately this may cause classpath collisions since there are _many_ copies of this annotation on Maven Central; we wanted one canonical source and javax.annotation-api seemed like that source. We hope this won't impact many users since we have always suggested using it only for compilation. But it will probably impact some users. However, we didn't create this mess, this seems to be "standard practice" for J2EE, which this annotation is now part of, so we're just impacted by it. Fixes #6833		2020-04-30 09:14:32 -07:00
..
src	examples: Add a JWT authentication example (#5915 )	2020-03-17 17:43:31 -07:00
README.md	examples: Add a JWT authentication example (#5915 )	2020-03-17 17:43:31 -07:00
build.gradle	Replace javax.annotation-api with Tomcat's annotations-api	2020-04-30 09:14:32 -07:00
pom.xml	Replace javax.annotation-api with Tomcat's annotations-api	2020-04-30 09:14:32 -07:00
settings.gradle	examples: Add a JWT authentication example (#5915 )	2020-03-17 17:43:31 -07:00

README.md

Authentication Example

This example illustrates a simple JWT-based authentication implementation in gRPC using server interceptor. It uses the JJWT library to create and verify JSON Web Tokens (JWTs).

The example requires grpc-java to be pre-built. Using a release tag will download the relevant binaries from a maven repository. But if you need the latest SNAPSHOT binaries you will need to follow COMPILING to build these.

The source code is here. To build the example, run in this directory:

$ ../gradlew installDist

The build creates scripts auth-server and auth-client in the build/install/example-jwt-auth/bin/ directory which can be used to run this example. The example requires the server to be running before starting the client.

Running auth-server is similar to the normal hello world example and there are no arguments to supply:

auth-server:

The auth-server accepts optional argument for port on which the server should run:

USAGE: auth-server [port]

The auth-client accepts optional arguments for server-host, server-port, user-name and client-id:

auth-client:

USAGE: auth-client [server-host [server-port [user-name [client-id]]]]

The user-name value is simply passed in the HelloRequest message as payload and the value of client-id is included in the JWT claims passed in the metadata header.

How to run the example:

# Run the server:
./build/install/example-jwt-auth/bin/auth-server 50051
# In another terminal run the client
./build/install/example-jwt-auth/bin/auth-client localhost 50051 userA clientB

That's it! The client will show the user-name reflected back in the message from the server as follows:

INFO: Greeting: Hello, userA

And on the server side you will see the message with the client's identifier:

Processing request from clientB

Maven

If you prefer to use Maven follow these steps. You can run the example as follows:

$ # Run the server
$ mvn exec:java -Dexec.mainClass=io.grpc.examples.authentication.AuthServer -Dexec.args="50051"
$ # In another terminal run the client
$ mvn exec:java -Dexec.mainClass=io.grpc.examples.authentication.AuthClient -Dexec.args="localhost 50051 userA clientB"