Skip to main content

A command-line tool for keystore management and APK signing for Android developers.

Project description

KeySigner: Keystore Management and APK Signing Tool

Overview

KeySigner is a command-line python tool designed to simplify keystore management and APK signing. It integrates KeyTool and ApkSigner, allowing developers to easily generate keystores (JKS, BKS, PKCS12), manage certificates, and sign APKs with custom keystores supporting multiple signature schemes (v1, v2, v3). Whether you need to create, convert, or sign, KeySigner provides a user-friendly interface for developers of all levels and efficient workflow.


Features

  • Generate Keystores: Easily create JKS, BKS, or PKCS12 keystores.
  • Keystore Migration: Seamlessly convert JKS or BKS keystores to PKCS12 format.
  • Certificate Extraction: Securely extract x509 certificates and private keys in PKCS8 format from PKCS12 keystores.
  • Keystore Info Display: Displays detailed information about the selected keystore, including certificate fingerprints, public key algorithm, expiries and more.
  • APK Signing: sign APK files with custom keystores, supporting multiple signing formats (v1, v2, v3).

Why Use KeySigner?

  • User-Friendly CLI: Interactive, step-by-step CLI to manage keystores and APK signing easily.
  • Time-Saving: Automates repetitive tasks related to keystore management and signing.
  • Flexible: Supports various keystore formats and all APK signing versions.
  • Secure: Ensures that certificates and APKs are handled safely and professionally.
  • Automated Commands: Automatically generates KeyTool and ApkSigner commands for easy use.

Requirements

Before using KeySigner, ensure that the following system dependencies are installed:

  1. Python: Required to run the KeySigner tool.
  2. Java: Required for KeyTool and ApkSigner.
  3. KeyTool: Part of the JDK, used for keystore management.
  4. ApkSigner: Available through sdkmanager, used for signing APKs.
  5. OpenSSL: Required for handling certificates and private keys.

Installation

Termux (Android)

To install KeySigner on Termux, use the following command to install all necessary dependencies:

pkg install python openjdk-17 keytool apksigner openssl-tool

Installation via pip (Recommended)

You can easily install KeySigner using pip:

pip install keysigner

For the latest changes and features, install KeySigner directly from the GitHub repository:

pip install -U git+https://github.com/muhammadrizwan87/keysigner.git

Custom Build Installation

To build KeySigner from source:

  1. Clone the repository:

    git clone https://github.com/muhammadrizwan87/keysigner.git
    
  2. Navigate to the KeySigner directory:

    cd keysigner
    
  3. Install the build tools:

    pip install build
    
  4. Build and install the package:

    python -m build
    pip install --force-reinstall dist/keysigner-1.0-py3-none-any.whl
    

Usage

To start using KeySigner, simply run the tool using the keysigner command and follow the interactive instructions.

Example:

$ keysigner

Select an option:
1. Create new JKS keystore
2. Create new BKS keystore
3. Create new PKCS12 keystore
4. Migrate JKS to PKCS12
5. Migrate BKS to PKCS12
6. Convert PKCS12 to PEM and extract x509 certificate and private key
7. Show keystore information
8. Sign APK
9. Show Notes
q. Quit

Contributing

We welcome contributions! Feel free to submit issues or pull requests on GitHub if you encounter any bugs or have suggestions for new features.


License

This project is licensed under the MIT License. You can view the license details in the LICENSE file.


Author

MuhammadRizwan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

keysigner-1.0.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keysigner-1.0-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file keysigner-1.0.tar.gz.

File metadata

  • Download URL: keysigner-1.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for keysigner-1.0.tar.gz
Algorithm Hash digest
SHA256 368665615e1133751d9d673ec1b825d92971bc218d6e7b9c9be26c662f3e07e7
MD5 a387ff14b3b31318950c3402041ab6ee
BLAKE2b-256 aa96d179604fabb245af4c3cb4a1f706dcedcfbdd09eb9d89eafca27a5ac9b4c

See more details on using hashes here.

File details

Details for the file keysigner-1.0-py3-none-any.whl.

File metadata

  • Download URL: keysigner-1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for keysigner-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae5200dce747a4646a6ac3965cde5b9298665793e30934a9818a427d6970ea70
MD5 386fa82215ffb7b95e0426ef7e8624b9
BLAKE2b-256 0994dc9ffcd29fe3bb4eeb65428f47aa6bdfd5832d9b89ca837e3db5bcfaa3f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page