Skip to content

Commit 65d8108

Browse files
samuellaurensamuellauren
committed
Rework Python examples
1 parent 576b8b8 commit 65d8108

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+5027
-1060
lines changed

‎.gitignore

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
*.pyc
21
*.egg-info
3-
__pycache__
4-
/go/scanner/atlant-scanner
5-
/javascript/scanner/node_modules
6-
/env
2+
*.pyc
73
.gradle
4+
/env
5+
/go/scanner/atlant-scanner
86
/java/scanner/build
7+
/javascript/scanner/node_modules
8+
__pycache__
9+
dist

‎LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

Lines changed: 37 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,50 @@
1-
# WithSecure Atlant API Examples
1+
# WithSecure Atlant Integration Guide
22

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-
and detect malicious files.
3+
This repository contains tutorials and examples that demonstrate how to
4+
seamlessly integrate with WithSecure Atlant. Atlant is a powerful self-hosted
5+
service designed to scan files for malicious content, detect spam, and classify
6+
URLs. With Atlant, you can access these capabilities through a simple and
7+
intuitive REST API or integrate with existing ICAP-based solutions.
68

7-
Atlant provides a REST API for scanning files and managing the product
8-
configuration. Applications and services can use the API resources to analyze
9-
content using always up-to-date heuristics and statistical techniques.
9+
Whether you're new to Atlant or an experienced user, this repository provides
10+
comprehensive guidance on how to make the most of its features. Our tutorials
11+
and examples are designed to be easy to follow, with clear instructions and
12+
practical examples that you can adapt to your needs.
1013

1114
## Getting Started with Atlant Using cURL
1215

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+
[This tutorial](curl/README.md) explains how to get started with Atlant using
17+
cURL. It shows how to install and configure Atlant and how to perform common
18+
scanning tasks using the command-line `curl` utility.
1619

17-
## Python Examples
20+
## Getting Started with Atlant Using Python
1821

19-
Python examples are available in `python` directory. The directory contains a
20-
Python package that provides a number of utilities that demonstrate how the
21-
WithSecure Atlant APIs can be used to configure the product and scan files. The
22-
included example utilities are:
22+
[Python directory](python) houses a collection of Python libraries and
23+
applications that showcase using Atlant's diverse capabilities from Python.
2324

24-
- `atlant-token`: Tool for fetching access tokens from WithSecure Atlant's
25-
internal authorization server
26-
- `atlant-get`: Tool for getting setting values using configuration API
27-
- `atlant-set`: Tool for changing setting values using configuration API
28-
- `atlant-scan`: Tool for scanning files using scanning API
29-
- `atlant-web`: Example web app for scanning files
30-
- `atlant-icap`: Tool for using the ICAP interface
31-
- `atlant-dirscan`: Tool for scanning directories for harmful content
25+
The [`atlant`](python/atlant) module provides a client library for interacting
26+
with Atlant's REST API. The library enables Python code to scan files and other
27+
types of content using Atlant, and also offers configuration management
28+
capabilities. In addition to the library, the module includes a command-line
29+
tool with the same name and similar functionality. See [module-level
30+
documentation](python/atlant/README.md) for more information about the library
31+
and the associated command-line tool.
3232

33-
### Installation
33+
The [`asyncio-icap-client`](python/asyncio-icap-client) module is a
34+
general-purpose ICAP client library for Python built on top of
35+
[`asyncio`](https://docs.python.org/3/library/asyncio.html). This module is not
36+
tied to Atlant, but can be used for interacting with any ICAP server.
3437

35-
On a typical Linux system, the simplest way to try out the example utilities is
36-
to install them in a [virtual environment](https://docs.python.org/3/library/venv.html).
38+
The [`demo-web-app`](python/demo-web-app) directory contains a sample web
39+
application that internally employs Atlant to scan files. The application is
40+
distributed as a set of containers that can be easily deployed using [Docker
41+
compose](https://docs.docker.com/compose/).
3742

38-
This can be achieved by running the following commands in project's root
39-
directory:
43+
## Examples in Other Languages
4044

41-
``` shell
42-
python3 -m venv env
43-
source env/bin/activate
44-
cd python
45-
./setup.py develop
46-
```
47-
48-
Now the example utilities should be available in current shell's path.
49-
50-
#### Scanning Directories with atlant-dirscan
51-
52-
`atlant-dirscan` Utility can be used for scanning directories for harmful
53-
content. Scan results are written to a CSV file.
54-
55-
```
56-
usage: atlant-dirscan [-h] config dir output
57-
58-
Scan directory for harmful files.
59-
60-
positional arguments:
61-
config Configuration file path.
62-
dir Directory to scan.
63-
output Output file path.
64-
65-
optional arguments:
66-
-h, --help show this help message and exit
67-
```
68-
69-
`atlant-dirscan` requires that a path to a configuration file is supplied on the
70-
command line. The configuration file should have the following format:
71-
72-
```
73-
{
74-
"authorization_address": "authorization.example.com:8081",
75-
"scanner_address": "scanner.example.com:8082",
76-
"client_id": "...",
77-
"client_secret": "...",
78-
"security_cloud": false,
79-
"allow_upstream_application_files": true,
80-
"allow_upstream_data_files": false
81-
}
82-
```
83-
84-
## Java Examples
85-
86-
In `java/scanner`, there is an example command line based file scanning client
87-
written in Java 11. The client along with its dependencies can be built into a
88-
single JAR-file using [Gradle](https://gradle.org):
89-
90-
``` shell
91-
cd java/scanner
92-
./gradlew shadowJar
93-
```
94-
95-
The client can be invoked as:
96-
97-
``` shell
98-
java -jar build/libs/scanner-all.jar AUTH-URL SCAN-URL CLIENT-ID CLIENT-SECRET FILE
99-
```
100-
101-
Here `AUTH-URL` is Atlant authorization server address and `SCAN-URL` is a
102-
scanning server address. See WithSecure Atlant user guide for information on how
103-
to setup Atlant.
104-
105-
## Go Examples
106-
107-
In `go/scanner`, there is an example Go command line client capable of scanning
108-
files using WithSecure Atlant file scanning API. The client can be built with:
109-
110-
``` shell
111-
cd go/scanner
112-
go build
113-
```
114-
115-
The client can be invoked as:
116-
117-
``` shell
118-
atlant-scanner AUTH-URL SCAN-URL CLIENT-ID CLIENT-SECRET FILE
119-
```
120-
121-
122-
## JavaScript Examples
123-
124-
In `javascript/scanner`, there is an example command line based file scanning
125-
client build on top of Node.js. The client can be invoked as:
126-
127-
``` shell
128-
atlant-scanner AUTH-URL SCAN-URL CLIENT-ID CLIENT-SECRET FILE
129-
```
45+
While the Python libraries and tools are the most comprehensive ones, we have
46+
also included additional examples in other languages for demonstration purposes:
13047

48+
- [Examples in Java](java)
49+
- [Examples in JavaScript](javascript)
50+
- [Examples in Go](go)

0 commit comments

Comments
 (0)