https://github.com/fofapro/vulfocus-py
https://github.com/fofapro/vulfocus-py
vulfocus
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fofapro/vulfocus-py
- Owner: fofapro
- License: apache-2.0
- Created: 2021-11-23T04:35:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-04T13:32:40.000Z (over 4 years ago)
- Last Synced: 2025-04-15T03:17:16.665Z (about 1 year ago)
- Topics: vulfocus
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vulfocus-py
[](https://github.com/fofapro/vulfocus-py/releases) [](https://github.com/fofapro/vulfocus-py/stargazers) [](https://github.com/fofapro/vulfocus-py/blob/master/LICENSE)
[Chinese document](https://github.com/fofapro/vulfocus-py/blob/master/README_zh.md)
## Vulfocus API
[`Vulfocus API`](https://fofapro.github.io/vulfocus/#/VULFOCUSAPI) is the `RESUFul API` interface provided by [`Vulfocus`](http://vulfocus.io/) for development, allowing Developers integrate [`Vulfocus`](http://vulfocus.io) in their own projects.
## Vulfocus SDK
The `Python` version of `SDK` written based on the [`Vulfocus API`](https://fofapro.github.io/vulfocus/#/VULFOCUSAPI) makes it easy for `Python` developers to quickly integrate [`Vulfocus`](http://vulfocus.io/) into their projects.
## Install
pip install vulfocus
## USE
|field|description|
| ---- | ---- |
|`username`|User login [`Vulfocus`](http://vulfocus.io/) userbox `username`|
|licence|Please go to the [`personal center`](http://vulfocus.fofa.so/#/profile/index) to view `API licence`|
### Pull Images
```python
from vulfocus.vulfocusClient import VulfocusClient
clinet = VulfocusClient(username="xxxx",licence="xxxxxx")
images = clinet.get_images()
print(images)
```
#### Response
ImageEntity(image_name='vulfocus/webmin-cve_2020_35606:latest', image_vul_name='Webmin 命令执行漏洞 （CVE-2020-35606）', image_desc='Webmin是Webmin社区的一套基于Web的用于类Unix操作系统中的系统管理工具。\nWebmin 1.962版本及之前版本存在安全漏洞，该漏洞允许执行任意命令。任何被授权使用Package Updates模块的用户都可以使用根权限通过包含和的向量执行任意命令。\n账户密码：root:password')
### Start
```python
from vulfocus.vulfocusClient import VulfocusClient
clinet = VulfocusClient(username="xxxx",licence="xxxxx")
images = clinet.get_images()
print(clinet.start_container(images[0].image_name))
```
#### Response
HostEntity(host=x.x.x.x:57581,port={'10000': '57581'})
### Stop
```python
from vulfocus.vulfocusClient import VulfocusClient
clinet = VulfocusClient(username="xxxx",licence="xxxxx")
images = clinet.get_images()
print(clinet.stop_container(images[0].image_name))
```
#### Response
停止成功
### Delete
```python
from vulfocus.vulfocusClient import VulfocusClient
clinet = VulfocusClient(username="xxxx",licence="xxxxx")
images = clinet.get_images()
print(clinet.delete_container(images[0].image_name))
```
#### Response
删除成功
## Update Log
2021-11-29
```
Release
```