canarytools 1.0.11

概述

Python Canary API包装器允许访问Canary Web API

快速启动

假设您的API密钥和网站域都在手边：

importcanarytoolsconsole=canarytools.Console(api_key='API_KEY',domain='CLIENT_DOMAIN')

注意：您可以在控制台上找到您的api密钥和域。转到控制台的设置页并在 Canary控制台API您将找到您的API密钥您的域是控制台中“canary.tools”前面的标记 网址例如，https://testconsole.canary.tools/settingstestconsole中的就是域

或者， 您可以从Canary控制台API选项卡下载配置文件在文件里你可以找到说明 放在哪里。如果您的系统中有此项，api_key和domain参数将不再是 实例化console对象时必需。

使用console实例，您可以与Canary控制台进行交互：

# Get all devicesconsole.devices.all()# Acknowledge all incidents for a device older than 3 daysconsole.incidents.acknowledge(node_id='329921d242c30b5e',older_than='3d')# Iterate all devices and start the update processfordeviceinconsole.devices.all():device.update(update_tag='4ae023bdf75f14c8f08548bf5130e861')# Acknowledge and delete all host port scan Incidentsforincidentinconsole.incidents.unacknowledged():ifisinstance(incident,canarytools.IncidentHostPortScan):incident.acknowledge()incident.delete()# Create a web image Canarytokenconsole.tokens.create(kind=canarytools.CanaryTokenKinds.KIND_WEB_IMAGE,memo='Drop this token on DC box',web_image='/path/to/test.png',mimetype='image/png')# Print out the name of all incidents and the source IP addressforincidentinconsole.incidents.all():printincident.description,incident.src_host

请参阅api文档的documentation 更多关于canary控制台api的例子。

讨论和支持

请在首次搜索后将错误和功能请求作为问题提交到GitHub，以确保 类似的问题还没有提出。如果这样的问题已经存在，请 给它竖起大拇指的反应对包含附加内容的问题的评论 信息当然是受欢迎的

文件

文档位于http://canarytools.readthedocs.io。

许可证

Python Canary API包装器的源代码（v1.0.0+）在Revised BSD License下提供

• 版权所有（c），2017，Thinkst应用研究