file_sentry 0.2.0 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +22 -7
- data/lib/file_sentry/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '038280c3b1fdd9399c90743e646ac52e54beafd43b677ab42938e65070b413bd'
|
|
4
|
+
data.tar.gz: 8f46245693744561fb4d4b982714d53159794ec877d600649aea93fd07d7f3a9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 73c2c3595bca680d7328ecb6e072a4ce98a1577f08ae55c4b285218cfd2fa82594e817f3a360a34fca72216ba4a43871495c03899061b689a6a32a24d372de25
|
|
7
|
+
data.tar.gz: d5e43ac1738e73e4726866c0003eca21f1e1b29e152d48275eb5a9dc41017c3dfd98b874ab7d8a813560a2fdd17dd2bd8c9cfd22fa2571838a192b5de5b3810f
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# FileSentry
|
|
2
2
|
|
|
3
|
-
FileSentry is a gem that scans
|
|
4
|
-
It displays
|
|
3
|
+
FileSentry is a gem that scans a designated file for malware using a comprehensive suite of anti-malware engines.
|
|
4
|
+
It displays results from each engine as well as a brief summary. FileSentry is powered by the OPSWAT Metadefender Cloud API. To use this gem, you will need to create an account with OPSWAT. Don't worry, it's free to sign up!
|
|
5
5
|
|
|
6
6
|
## Installation
|
|
7
7
|
|
|
@@ -9,19 +9,34 @@ First, make sure you have the latest version of Ruby installed. FileSentry was d
|
|
|
9
9
|
|
|
10
10
|
If you do not have Ruby installed, follow the instructions on this blog post to install rbenv and Ruby 2.5.0:[Setup Ruby On Rails on Ubuntu 16.04 Xenial Xerus](https://gorails.com/setup/ubuntu/16.04).
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Only install Ruby and rbenv as specified in the 'Installing Ruby' section. Don't
|
|
13
|
+
forget to run
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
$ rbenv rehash
|
|
16
|
+
|
|
17
|
+
after installing bundler!
|
|
18
|
+
|
|
19
|
+
To install the gem, enter the following in your terminal of choice:
|
|
15
20
|
|
|
16
21
|
$ gem install file_sentry
|
|
17
22
|
|
|
18
|
-
You can also clone this repo if you want to tweak FileSentry
|
|
23
|
+
You can also clone this repo if you want to tweak FileSentry. Read the development section for more info if that floats your boat.
|
|
19
24
|
|
|
20
25
|
## Usage
|
|
26
|
+
If you do not have an OPSWAT account/API key, visit [portal.opswat.com](portal.opswat.com) to sign up. After creating an account, the "home" tab will display your OPSWAT API Key.
|
|
27
|
+
|
|
28
|
+
After installation, to scan a file for malware enter the following command:
|
|
29
|
+
|
|
30
|
+
$ file_sentry RELATIVE_PATH_TO_FILE (Optional)HASH_DIGEST
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
If this is your first time running the application, you will be prompted to enter your API key.
|
|
34
|
+
|
|
35
|
+
The RELATIVE_PATH_TO_FILE argument loads the specified file into FileSentry, relative to the current working directory. To enter a file name with spaces, use quotation marks or escape whitespace with a backslash.
|
|
21
36
|
|
|
22
|
-
|
|
37
|
+
The HASH_DIGEST argument is optional. If the gem is ran without the HASH_DIGEST argument, FileSentry will default to MD5.
|
|
23
38
|
|
|
24
|
-
|
|
39
|
+
You can change the API key at any time by running the gem without any command line arguments.
|
|
25
40
|
|
|
26
41
|
## Development
|
|
27
42
|
|
data/lib/file_sentry/version.rb
CHANGED