1
- # F-Secure Atlant API Examples
1
+ # WithSecure Atlant API Examples
2
2
3
- This repository contains examples for interacting with F-Secure Atlant API.
4
- F-Secure Atlant is a platform for building applications that are able to scan
3
+ This repository contains examples for interacting with WithSecure Atlant API.
4
+ WithSecure Atlant is a platform for building applications that are able to scan
5
5
and detect malicious files.
6
6
7
7
Atlant provides a REST API for scanning files and managing the product
8
8
configuration. Applications and services can use the API resources to analyze
9
9
content using always up-to-date heuristics and statistical techniques.
10
10
11
+ ## Getting Started with Atlant Using cURL
12
+
13
+ [ This guide] ( curl/README.md ) explains how to get started with Atlant using cURL.
14
+ It explains how to install and configure Atlant and how to do common scanning
15
+ tasks using command-line ` curl ` utility.
16
+
11
17
## Python Examples
12
18
13
19
Python examples are available in ` python ` directory. The directory contains a
14
20
Python package that provides a number of utilities that demonstrate how the
15
- F-Secure Atlant APIs can be used to configure the product and scan files. The
21
+ WithSecure Atlant APIs can be used to configure the product and scan files. The
16
22
included example utilities are:
17
23
18
- - ` atlant-token ` : Tool for fetching access tokens from F-Secure Atlant's
24
+ - ` atlant-token ` : Tool for fetching access tokens from WithSecure Atlant's
19
25
internal authorization server
20
26
- ` atlant-get ` : Tool for getting setting values using configuration API
21
27
- ` atlant-set ` : Tool for changing setting values using configuration API
@@ -24,7 +30,7 @@ included example utilities are:
24
30
- ` atlant-icap ` : Tool for using the ICAP interface
25
31
- ` atlant-dirscan ` : Tool for scanning directories for harmful content
26
32
27
- ### Running the Python Examples
33
+ ### Installation
28
34
29
35
On a typical Linux system, the simplest way to try out the example utilities is
30
36
to install them in a [ virtual environment] ( https://docs.python.org/3/library/venv.html ) .
@@ -93,13 +99,13 @@ java -jar build/libs/scanner-all.jar AUTH-URL SCAN-URL CLIENT-ID CLIENT-SECRET F
93
99
```
94
100
95
101
Here ` AUTH-URL ` is Atlant authorization server address and ` SCAN-URL ` is a
96
- scanning server address. See F-Secure Atlant user guide for information on how
102
+ scanning server address. See WithSecure Atlant user guide for information on how
97
103
to setup Atlant.
98
104
99
105
## Go Examples
100
106
101
107
In ` go/scanner ` , there is an example Go command line client capable of scanning
102
- files using F-Secure Atlant file scanning API. The client can be built with:
108
+ files using WithSecure Atlant file scanning API. The client can be built with:
103
109
104
110
``` shell
105
111
cd go/scanner
0 commit comments