lyang/gpg-utils

# gpg-utils [![Build](https://github.com/lyang/gpg-utils/actions/workflows/build.yml/badge.svg)](https://github.com/lyang/gpg-utils/actions/workflows/build.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/382b982629fafcdb7365/maintainability)](https://codeclimate.com/github/lyang/gpg-utils/maintainability) [![codecov](https://codecov.io/gh/lyang/gpg-utils/branch/main/graph/badge.svg?token=U8C2J0X2MC)](https://codecov.io/gh/lyang/gpg-utils) [![Maven Central](https://img.shields.io/maven-central/v/com.github.lyang/gpg-utils.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.lyang%22%20AND%20a:%22gpg-utils%22) [![javadoc](https://javadoc.io/badge2/com.github.lyang/gpg-utils/javadoc.svg)](https://javadoc.io/doc/com.github.lyang/gpg-utils)
`GPGUtils` is a simple wrapper for `ProcessBuilder` to make shell out to `gpg` easier in Java.

## What
It provides a simple interface for encrypting/decrypting `String`, `File` and `InputStream`.

There's also generic method to run other `gpg` command.

## Why
Existing solutions for using `gpg` in Java have mostly involved `BouncyCastle`. It works, but, its API isn't the nicest to use, to say the least.

Using `ProcessBuilder` is much simpler compared with `BouncyCastle`. But it's not easy to get IO buffering right for external processes.

`GPGUtils` tries to provide a simple interface while hiding away the complexity of IO buffer handling.

## How to use
Refer to the [Unit Tests](src/test/java/com/github/lyang/gpgutils/GPGUtilsTest.java) for now.

## Running Tests
```bash
mvn verify
```

## Deploy
Need to set environment variables first:
* `GPG_KEYNAME`
* `OSSRH_USERNAME`
* `OSSRH_PASSWORD`
```bash
mvn -s settings.xml -P ossrh clean deploy
```