https://github.com/virgilsecurity/demo-nexmo-chat-backend-java
This repository contains a sample backend code that demonstrates how to generate a Nexmo and Virgil JWTs using the Java/Android SDK.
https://github.com/virgilsecurity/demo-nexmo-chat-backend-java
backend e3kit java nexmo
Last synced: 8 months ago
JSON representation
This repository contains a sample backend code that demonstrates how to generate a Nexmo and Virgil JWTs using the Java/Android SDK.
- Host: GitHub
- URL: https://github.com/virgilsecurity/demo-nexmo-chat-backend-java
- Owner: VirgilSecurity
- License: bsd-3-clause
- Created: 2019-02-15T12:57:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-04T10:27:48.000Z (about 6 years ago)
- Last Synced: 2025-01-04T11:14:17.574Z (9 months ago)
- Topics: backend, e3kit, java, nexmo
- Language: Java
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sample Java Backend for Nexmo
This repository contains a sample backend code that demonstrates how to generate a Virgil JWT using the [Java/Android SDK](https://github.com/VirgilSecurity/virgil-sdk-java-android)
> Do not use this authentication in production. Requests to a /virgil-jwt endpoint must be allowed for authenticated users. Use your application authorization strategy.
## Prerequisites
* Java Development Kit (JDK) 8+
For IntelliJ IDEA Ultimate run:
* IntelliJ IDEA Ultimate 2018.3.3+
> If you have Community version of IDEA - go to `Building a Jar` section.
For building a jar:
* Maven 3+
## IntelliJ IDEA Ultimate run
- git clone https://github.com/VirgilSecurity/demo-nexmo-chat-backend-java
- Open IntelliJ IDEA -> File -> New -> Project from Existing Sources, locate `demo-nexmo-chat-backend-java` and click `open`
- Select `Import project from external model` -> `Maven`, go `next` till `Please select project SDK` page
- Select in list of available JDKs `1.8.xxx` version or greater. If you haven't JDK of `1.8.xxx` version [install](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) it. `Finish` setup.
- Fill in your [credentials](#get-virgil-credentials) into the `demo-nexmo-chat-backend-java/src/main/resources/`[`application.properties`](https://github.com/VirgilSecurity/demo-nexmo-chat-backend-java/blob/master/src/main/resources/application.properties) file.
- Run application
If server started successfully you will see in the end of logs:
```
: Tomcat started on port(s): 3000 (http)
: Started ServerApplication
```
> If you get error `Error:java: javacTask: source release 8 requires target release 1.8` go to IntelliJ IDEA -> Preferences -> Build, Execution, Deployment -> Compiler -> Java Compiler and select `8` in `Project bytecode version` field.
## Get Virgil Credentials
If you don't have an account yet, [sign up for one](https://dashboard.virgilsecurity.com/signup) using your e-mail.
- Create new E2EEv5 application;
- Create new API Key and copy given private key;
To generate a JWT the following values are required from the steps above:
| Variable Name | Description |
|-----------------------------------|--------------------------------|
| virgil.app.id | ID of your Virgil Application. |
| virgil.app.private_key | Private key of your APP key that is used to sign the JWTs. |
| virgil.app.key_id | ID of your APP key. A unique string value that identifies your account in the Virgil Cloud. |
- Replace credentials in [`application.properties`](https://github.com/VirgilSecurity/demo-nexmo-chat-backend-java/blob/master/src/main/resources/application.properties) with yours.
## Get Nexmo Credentials
- Register on https://developer.nexmo.com/
- [Create Nexmo Application](https://developer.nexmo.com/tutorials/client-sdk-generate-test-credentials#create-a-nexmo-application) and remember your generated `private.key` path
- Replace the in [`application.properties`](https://github.com/VirgilSecurity/demo-nexmo-chat-backend-java/blob/master/src/main/resources/application.properties) with your `app id` from the created app above:
```bash
Application created: aaaaaaaa-bbbb-cccc-dddd-0123456789ab
```
- Rename your Nexmo `private.key` to `virgilnexmodemo_private.key`
- Put it near `application.properties` file to the [resourses folder](https://github.com/VirgilSecurity/demo-nexmo-chat-backend-java/blob/master/src/main/resources/)
## Building a Jar
Possibly, you want to build a Jar to deploy it on a remote server (e.g. [Now](https://zeit.co/now), [Heroku](https://www.heroku.com/)).
### Clone
Clone the repository from GitHub.
```
$ git clone https://github.com/VirgilSecurity/e3kit-kotlin.git
```
### Build sources
```
$ mvn clean package -DskipTests
```
JAR file will be build in `target` directory.
### Run the Server
Run this command from the project's root folder:
```
$ java -jar target/server.jar
```
Now, use your client code to make a request to get a JWT from the sample backend that is working on http://localhost:3000.
You can verify the server with a command:
```bash
$ curl -X POST -H "Content-Type: application/json" \
-d '{"identity":"my_identity"}' \
http://localhost:3000/authenticate
```
The response should looks like:
```json
{"authToken":"my_identity-b5ba1680-4d5c-4b2e-9890-a0500d3c9bfe"}
```
## Specification
### /auth/authenticate endpoint
This endpoint is an example of users authentication. It takes user `identity` and responds with unique token.
```http
POST https://localhost:3000/authenticate HTTP/1.1
Content-type: application/json;
{
"identity": "string"
}
Response:
{
"authToken": "string"
}
```
### /auth/virgil-jwt endpoint
This endpoint checks whether a user is authorized by an authorization header. It takes user's `authToken`, finds related user identity and generates a `virgilToken` (which is [JSON Web Token](https://jwt.io/)) with this `identity` in a payload. Use this token to make authorized api calls to Virgil Cloud.
```http
GET https://localhost:3000/virgil-jwt HTTP/1.1
Content-type: application/json;
Authorization: Bearer
Response:
{
"virgilToken": "string"
}
```
### /auth/nexmo-jwt endpoint
This endpoint checks whether a user is authorized by an authorization header. It takes user's `authToken`, finds related user identity and generates a `nexmoToken` (which is [JSON Web Token](https://jwt.io/)) with this `identity` in a payload. Use this token to make authorized api calls to Nexmo services.
> Current implementation provides only `/v1/sessions/**` and `/v1/conversations/**` ACLs (It's enough for text chat). You can modify this server to suit your needs for example passing ACLs as a query parameters to GET request and then add requested ACLs to you JWT.
```http
GET https://localhost:3000/virgil-jwt HTTP/1.1
Content-type: application/json;
Authorization: Bearer
Response:
{
"nexmoToken": "string"
}
```
### /users/create endpoint
This endpoint checks whether a user is authorized by an authorization header. It [creates a user](https://developer.nexmo.com/api/conversation#createUser) on the `Nexmo` service and returns user's `id` and `reference`.
```http
POST https://localhost:3000/authenticate HTTP/1.1
Content-type: application/json;
Authorization: Bearer
{
"name": "string",
"display_name": "string"
}
Response:
{
"id": "string",
"href": "string"
}
```
## Virgil JWT Generation
To generate JWT, you need to use the `JwtGenerator` class from the SDK.
```Java
public JwtGenerator jwtGenerator() throws CryptoException {
VirgilCrypto crypto = new VirgilCrypto();
PrivateKey privateKey = crypto.importPrivateKey(ConvertionUtils.base64ToBytes(this.appKey));
AccessTokenSigner accessTokenSigner = new VirgilAccessTokenSigner();
JwtGenerator jwtGenerator = new JwtGenerator(appId, privateKey, appKeyIdentifier,
TimeSpan.fromTime(1, TimeUnit.HOURS), accessTokenSigner);
return jwtGenerator;
}
```
Then you need to provide an HTTP endpoint which will return the JWT with the user's identity as a JSON.
For more details take a look at the [AuthenticationService.java](src/main/java/com/virgilsecurity/demo/server/service/AuthenticationService.java) file.
## License
This library is released under the [3-clause BSD License](LICENSE.md).
## Support
Our developer support team is here to help you. Find out more information on our [Help Center](https://help.virgilsecurity.com/).
You can find us on [Twitter](https://twitter.com/VirgilSecurity) or send us email support@VirgilSecurity.com.
Also, get extra help from our support team on [Slack](https://virgilsecurity.com/join-community).