sifaka

README

Sifaka

Sifaka is a tool to monitor your x509 certificates or simply websites certificates expirey date.

Sifaka interface is mostly CLI but it also runs a server than cant notify you via Slack (version v0.0.1).

It will notify You 29 days before certificate will expire. (It will repeat notifications every 4 hours until you fix it ;) )

The Name

A sifaka is a lemur of the genus Propithecus from the family Indriidae within the order Primates. The name of their family is an onomatopoeia of their characteristic "shi-fak" alarm call.

Source: Wikipedia: https://en.wikipedia.org/wiki/Sifaka

Usage

Command you can use

• sifaka check - standalone command to check cert expiration date from --url= url or --file= file
• sifaka add - checks cert and adds it to sifaka database for tracking
• sifaka list - lists all certs in database with expirations in CSV format
• sifaka remove - removes by --id= (from list) cert from sifaka database
• sifaka server - runs the app server, periodic checks and notifications and hosts on --port= simple website that lists the certificates

Example

To add cert to sifaka database:

via website url

./bin/sifaka add -u https://google.com

or via file

./bin/sifaka add -f sample.cer

To run server on a selected port eg. 7788

./bin/sifaka server -p 7788

to list all certs in sifaka db

./bin/sifaka list

to remove cert from db via id

./bin/sifaka remove --id=69420

Install

By default sifaka stores its data in data/sifaka.db where the app exists. Be sure that the directory data exists and is owned in a way sifaka can make files in it. That is the only requirement for the app to run.

from binary

Via releases. Go to https://github.com/JakubOboza/sifaka/releases

1. Download the binary
2. Untar it eg tar -zxvf sifaka.tar.gz
3. run it ./sifaka server
4. visit http://localhost:6123

from source

You will need go at least 1.16, sqlite3 and gcc in your system to build sifaka.

1. clone repo git clone https://github.com/JakubOboza/sifaka
2. cd sifaka
3. make build
4. run it ./bin/sifaka server
5. visit http://localhost:6123

Documentation

Overview

Copyright © 2022 Jakub Oboza <jakub.oboza@gmail.com>

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.