tcs-garr 0.12.0

Command-line tool to manage and interact with Harica platform

TCS-GARR Client

Overview

The TCS-GARR Client is a command-line tool for managing and interacting with Harica platform. It offers features like listing, downloading, issuing certificates, approving requests, and generating domain validation tokens, all via the Harica API.

Warning ⚠️

Consortium GARR is not affiliated with HARICA, and the present work has not been endorsed by or agreed with HARICA.

Consortium GARR provides this code to the community for sharing purposes but does not commit to providing support, maintenance, or further development of the code. Use it at your own discretion.

Prerequisites

Before using the TCS-GARR client, please ensure the following:

1. Create a local account on the Harica platform: You must create a local account on Harica at https://cm.harica.gr. Do not use federated IDEM credentials, as they do not support API access.

   • If you're already logged in with federated IDEM credentials, you can create a new local account using an email alias. Federated users do not have a password and therefore cannot use the API.

2. Administrator and Approver Permissions: To use the API, your local account must have Administrator and Approver permissions. To obtain these:

   • Enable 2FA (Two-Factor Authentication) on your profile page.
   • Save the TOTP seed provided after enabling 2FA, as you will need it for future authentication. TOTP seed is like otpauth://totp/HARICA:...omissis...
   • After enabling 2FA, request an existing administrator to elevate your account to Administrator and Approver.

Once these steps are completed, you are ready to use the TCS-GARR client.

Installation

You can install the TCS-GARR client in a virtual environment or via pipx.

Virtual Environment

1. Open a terminal or command prompt and navigate to the directory where you want to install the package. Then, run the following command to create a virtual environment:

   mkdir <path>
   python -m venv venv
   

   This will create a folder named venv in your project directory, containing a self-contained Python environment.

2. Activate the virtual environment based on your operating system:

   source venv/bin/activate
   

3. Install the package

   pip install tcs-garr
   

Pipx

1. Open a terminal and install the package

   PIPX_BIN_DIR=/usr/local/bin pipx install tcs-garr
   

Configuration

After installation, the first time you run the client, you will need to initialize the configuration file with your credentials by running:

tcs-garr init

This will create a tcs-garr.conf file in your home directory under .config/tcs-garr path. This file will contain your Harica username, password, TOTP seed, and folder for issued certificates and will have secure permissions.

If configuration file is not found, system will notify you to initialize the configuration using the tcs-garr init command.

Usage

Once the setup is complete, you can use the TCS-GARR client for various operations. The command syntax follows this pattern:

tcs-garr [command] [options]

To view all available commands and options:

tcs-garr --help

usage: tcs-garr [-h] [--debug] {list,request,init,download,approve,whoami,validate,domains,cancel} ...

Harica Certificate Manager

positional arguments:
  {list,request,init,download,approve,whoami,validate,domains,cancel,k8s}
    list                Generate a report from Harica
    request             Request a new certificate
    init                Generate Harica config file
    download            Download a certificate by ID
    approve             Approve a certificate by ID
    whoami              Get logged in user profile
    validate            Create validation token for domains
    domains             List available domains
    cancel              Cancel a request by ID
    k8s                 Generate Kubernetes tls resource file

options:
  -h, --help            show this help message and exit
  --debug               Enable DEBUG logging.
  --version             show program's version number and exit

Available Commands

1. Initialize configuration:

   tcs-garr init
   

   This command initializes the configuration file with your credentials (email, password, and TOTP seed).

2. Get user profile:

   tcs-garr whoami
   

   This command retrieves the profile of the logged-in user.

3. List all certificates:

   tcs-garr list --help
   
   usage: tcs-garr list [-h] [--expired-since EXPIRED_SINCE] [--expiring-in EXPIRING_IN]
   
   options:
   -h, --help            show this help message and exit
   --expired-since EXPIRED_SINCE
                           List certificates which expiry date is X days before now.
   --expiring-in EXPIRING_IN
                           List certificates which expiry date is X days after now.
   

   This command will list all available certificates. You can filter them by date range using the --expired-since and --expiring-in options.

4. Download a certificate:

   tcs-garr download --help
   
   usage: tcs-garr download [-h] --id ID [--output-filename OUTPUT_FILENAME] [--force] [--download-type {pemBundle,certificate}]
   
    options:
    -h, --help            show this help message and exit
    --id ID               ID of the certificate to download.
    --output-filename OUTPUT_FILENAME
                            Optional filename to save the certificate inside default output_folder.
    --force, -f           Force overwrite if the output file already exists.
    --download-type {pemBundle,certificate}
                            Type of download: 'pemBundle' or 'certificate'. Default is 'pemBundle'.
   

   Replace ID with the ID of the certificate you wish to download. You can use pemBundle or certificate as arguments for specific download formats.

5. Request a new certificate:

   tcs-garr request --help
   
   usage: tcs-garr request [-h] [--profile {OV,DV}] (--csr CSR | --cn CN) [--alt_names ALT_NAMES]
   
   options:
   -h, --help            show this help message and exit
   --profile {OV,DV}     Profile to use between OV or DV. Default. OV
   --csr CSR             Path to an existing CSR file.
   --cn CN               Common name of the certificate.
   --alt_names ALT_NAMES
                           Comma-separated alternative names (only used with --cn).
   

   The request command is used to submit a new certificate request to Harica.

   You can either provide an existing Certificate Signing Request (--csr) or specify the details for generating a new CSR, including the Common Name (--cn) and any Subject Alternative Names (--alt_names). If a new CSR is created using the --cn and --alt_names options, a private key will also be automatically generated.

   You can choose between the OV (OV Profile) or DV (DV Profile) profile using the --profile option. Default is OV.

   After submitting the certificate request, the request must be approved by another Administrator before the certificate can be downloaded. Ensure that an administrator is available to review and approve your request.

6. Approve a certificate:

   usage: tcs-garr approve [-h] (--id ID | --list-pending | --all)
   
   options:
   -h, --help      show this help message and exit
   --id ID         ID of the certificates (comma separated) to approve.
   --list-pending  List all pending requests.
   --all           Approve all pending requests.
   

   You can list all pending requests using the --list-pending option or approve all pending requests using the --all option.

   You can also approve a specific certificate by providing its ID using the --id option.

7. Cancel a certificate request:

   tcs-garr cancel --help
   
   usage: tcs-garr cancel [-h] --id ID
   
   options:
   -h, --help  show this help message and exit
   --id ID     ID of the request to cancel.
   

   Replace ID with the ID of the certificate you wish to cancel.

8. Generate validation token for domains:

   usage: tcs-garr validate [-h] --domains DOMAINS
   
   options:
   -h, --help         show this help message and exit
   --domains DOMAINS  Comma separated list of domains.
   

   This command generates validation tokens for the specified domains. Replace DOMAINS with a comma-separated list of domains you need to validate.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Contributing and Further Development

Contributions, further developments, error reports (and possibly fixes) are welcome.

For more info, please read the CONTRIBUTING file.