summaryrefslogtreecommitdiffstats
path: root/vtcli/README.md
blob: b39f6a09d3184ed16ce4a8587be4f224118a1723 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
[vtcli]
=======

Containerised (Podman) Virus Total client that uses an API stored as Podman Secret (sekurrre!) on the executing machine (so one a) won't have to store the API key in plain nor b) provide it during runtime).

Requirements
------------

This work has been developed and tested on Fedora with podman/buildah.

Prerequisites
-------------

The Virus Total client uses an API key that can be stored as environment variable during container runtime.

In order to avoid hardcoding credentials "podman secret" is being used.

The following steps are required ONCE (on the machine the container runs) prior to building and running the container:

- export VTAPIKEY=(insert api key used for access here)
- podman secret create --env VirustotalToken VTAPIKEY

Instructions for use
--------------------

Building:

```
cd vtcli
buildah bud -t vtcli . && podman image prune -f
```

Running:

```
podman run -it --secret source=VirustotalToken,type=env,target=VTCLI_APIKEY --rm vtcli [command] (see vtcli --help for options)
```

License
-------

GPLv3

Author Information
------------------

Timo Trinks, ttrinks@fedoraproject.org

Acknowledgements
------------------

N/A