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 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-2.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

• Telegram Channel: TDOhex
• Second Channel: Android Patches
• Discussion Group: Discussion of TDOhex
• GitHub: MuhammadRizwan87