Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramortegui/clamxir
CalmAV wrapper for elixir
https://github.com/ramortegui/clamxir
antivirus clamav clamdscan clamscan elixir malware-detection phoenix phoenix-framework security security-scanner security-tools web
Last synced: about 1 month ago
JSON representation
CalmAV wrapper for elixir
- Host: GitHub
- URL: https://github.com/ramortegui/clamxir
- Owner: ramortegui
- Created: 2018-08-19T02:25:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T07:43:45.000Z (about 2 years ago)
- Last Synced: 2024-11-01T09:33:40.260Z (2 months ago)
- Topics: antivirus, clamav, clamdscan, clamscan, elixir, malware-detection, phoenix, phoenix-framework, security, security-scanner, security-tools, web
- Language: Elixir
- Homepage:
- Size: 36.1 KB
- Stars: 13
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - ClamAV wrapper for elixir. (Security)
- fucking-awesome-elixir - clamxir - ClamAV wrapper for elixir. (Security)
- awesome-elixir - clamxir - ClamAV wrapper for elixir. (Security)
README
# Clamxir [](https://travis-ci.org/ramortegui/clamxir)
ClamAV wrapper for elixir based on
[clamby](https://github.com/kobaltz/clamby)
This package depends of clamav installed on your system. Please refer to: [https://www.clamav.net/documents/installing-clamav](https://www.clamav.net/documents/installing-clamav).
As recomendation, use the daemonize flag on the configs, in order to improve
performance.
## Installation
The package can be installed by adding `clamxir` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:clamxir, "~> 0.1.8"}
]
end
```
## Usage
Clamxir receive the configs on each public method, and based on the configs,
will perform their task.
The config file by default is the struct `%Clamxir{}`. The default values of
the structure are:
```elixir
%Clamxir{
daemonize: false,
stream: false,
check: fase
}
```
daemonize is a flag to use one instance of the clamav instead of
the creation of new instances for each request.
```elixir
iex> Clamxir.safe?(%Clamxir{}, "/path/file")
```
stream will pass the argument --stream to clamdscan, this will help
to avoid permission issues.
```elixir
iex> Clamxir.safe?(%Clamxir{stream: true}, "/path/file")
```
check flag will add validation of the scanner availability before try
to run it.
```elixir
iex> Clamxir.safe?(%Clamxir{check: true}, "/path/file")
```
## Integration with Phoenix
1. Install as dependency
mix.exs
```elixir
{:clamxir, "~> 0.1.8"}
```
2. Use in the controller action where the files are uploaded
```elixir
def upload(conn, params) do
file = params["index"]["file"]
# Requires to have clamavdscann to work
case Clamxir.safe?(%Clamxir{daemonize: true}, file.path) do
true ->
# Process the file and ...
conn
|> put_flash(:info, "Created successfully")
|> redirect(to: "/")
false -> conn
|> put_flash(:error, "Virus!!")
|> redirect(to: "/")
end
end
```
For a working sample please refer to:
[https://github.com/ramortegui/sample_phoenix_clamxir](https://github.com/ramortegui/sample_phoenix_clamxir)
Docs can be found at [https://hexdocs.pm/clamxir](https://hexdocs.pm/clamxir).
## TODO
- Add Logger features