Skip to content

kibotu/Android-PGP

Repository files navigation

Donation About Jan Rabe

Android-PGP Android Arsenal Javadoc Build Status API Gradle Version Kotlin Licence

Introduction

Adds PGP encryption and decryption support.

Screenshot

How to install

repositories {
    maven {
        url "https://jitpack.io"
    }
}

dependencies {
    implementation 'com.github.kibotu:android-pgp:-SNAPSHOT'
}

How to use

1.1 Generate a Key-Pair

val krgen = Pgp.generateKeyRingGenerator("password".toCharArray())
val publicKey = Pgp.genPGPPublicKey(krgen)
val privateKey = Pgp.genPGPPrivKey(krgen)

1.2 or provide one pair

Pgp.setPublicKey("rsa.pub".openFromAssets())
Pgp.setPrivateKey("rsa".openFromAssets())

2 Encrypt

encrypted = Pgp.encrypt("my secret message")

3 Decrypt

decrypted = Pgp.decrypt(encrypted, "password")

How to build

graldew clean build

CI

gradlew clean assembleRelease test javadoc

Build Requirements

  • JDK8
  • Android Build Tools 27.0.2
  • Android SDK 27

Notes

Follow me on Twitter: @wolkenschauer

Let me know what you think: [email protected]

Contributions welcome!

Contributors

License

This library also includes the The Bouncy Castle Crypto package which is licensed under MIT.

Copyright 2018 Jan Rabe

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.