kraken-sdk

The core component of kraken-project

This Python package is automatically generated by the OpenAPI Generator project:

API version: 0.1.0
Package version: 0.1.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/myOmikron/kraken-project.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/myOmikron/kraken-project.git)

Then import the package:

import kraken_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kraken_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import kraken_sdk
from kraken_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kraken_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'


# Enter a context with an instance of the API client
async with kraken_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kraken_sdk.AdminWorkspacesApi(api_client)

    try:
        # Retrieve all workspaces
        api_response = await api_instance.get_all_workspaces_admin()
        print("The response of AdminWorkspacesApi->get_all_workspaces_admin:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminWorkspacesApi->get_all_workspaces_admin: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminWorkspacesApi	get_all_workspaces_admin	GET /api/v1/admin/workspaces	Retrieve all workspaces
AdminWorkspacesApi	get_workspace_admin	GET /api/v1/admin/workspaces/{uuid}	Retrieve a workspace by id
ApiKeysApi	create_api_key	POST /api/v1/apiKeys	Create new api key
ApiKeysApi	delete_api_key	DELETE /api/v1/apiKeys/{uuid}	Delete an existing api key
ApiKeysApi	get_api_keys	GET /api/v1/apiKeys	Retrieve all api keys
ApiKeysApi	update_api_key	PUT /api/v1/apiKeys/{uuid}	Update an api key by its id
AttacksApi	bruteforce_subdomains	POST /api/v1/attacks/bruteforceSubdomains	Bruteforce subdomains through a DNS wordlist attack
AttacksApi	delete_attack	DELETE /api/v1/attacks/{uuid}	Delete an attack and its results
AttacksApi	dns_resolution	POST /api/v1/attacks/dnsResolution	Perform domain name resolution
AttacksApi	get_all_attacks	GET /api/v1/attacks	Retrieve all attacks the user has access to
AttacksApi	get_attack	GET /api/v1/attacks/{uuid}	Retrieve an attack by id
AttacksApi	get_bruteforce_subdomains_results	GET /api/v1/attacks/{uuid}/bruteforceSubdomainsResults	Retrieve a bruteforce subdomains' results by the attack's id
AttacksApi	get_dns_resolution_results	GET /api/v1/attacks/{uuid}/dnsResolutionResults	Retrieve a dns resolution's results by the attack's id
AttacksApi	get_host_alive_results	GET /api/v1/attacks/{uuid}/hostAliveResults	Retrieve a host alive's results by the attack's id
AttacksApi	get_query_certificate_transparency_results	GET /api/v1/attacks/{uuid}/queryCertificateTransparencyResults	Retrieve a query certificate transparency's results by the attack's id
AttacksApi	get_query_unhashed_results	GET /api/v1/attacks/{uuid}/queryUnhashedResults	Retrieve a query dehashed's results by the attack's id
AttacksApi	get_service_detection_results	GET /api/v1/attacks/{uuid}/serviceDetectionResults	Retrieve a detect service's results by the attack's id
AttacksApi	get_tcp_port_scan_results	GET /api/v1/attacks/{uuid}/tcpPortScanResults	Retrieve a tcp port scan's results by the attack's id
AttacksApi	get_workspace_attacks	GET /api/v1/workspaces/{uuid}/attacks	Query all attacks of a workspace
AttacksApi	hosts_alive_check	POST /api/v1/attacks/hostsAlive	Check if hosts are reachable
AttacksApi	query_certificate_transparency	POST /api/v1/attacks/queryCertificateTransparency	Query a certificate transparency log collector.
AttacksApi	query_dehashed	POST /api/v1/attacks/queryDehashed	Query the dehashed API.
AttacksApi	scan_tcp_ports	POST /api/v1/attacks/scanTcpPorts	Start a tcp port scan
AttacksApi	service_detection	POST /api/v1/attacks/serviceDetection	Perform service detection on a ip and port combination
AuthenticationApi	finish_auth	POST /api/v1/auth/finishAuth	Finishes the authentication with a security key
AuthenticationApi	finish_register	POST /api/v1/auth/finishRegister	Finish the registration of a security key
AuthenticationApi	login	POST /api/v1/auth/login	Login to kraken
AuthenticationApi	logout	GET /api/v1/auth/logout	Log out of this session
AuthenticationApi	start_auth	POST /api/v1/auth/startAuth	Starts the authentication with a security key
AuthenticationApi	start_register	POST /api/v1/auth/startRegister	Start the registration of a security key
AuthenticationApi	test	GET /api/v1/auth/test	Test the current login state
DomainsApi	create_domain	POST /api/v1/workspaces/{uuid}/domains	Manually add a domain
DomainsApi	get_all_domains	POST /api/v1/workspaces/{uuid}/domains/all	Retrieve all domains of a specific workspace
DomainsApi	get_domain	GET /api/v1/workspaces/{w_uuid}/domains/{d_uuid}	Retrieve all information about a single domain
DomainsApi	update_domain	PUT /api/v1/workspaces/{w_uuid}/domains/{d_uuid}	Update a domain
GlobalTagsApi	create_global_tag	POST /api/v1/admin/globalTags	Create a global tag.
GlobalTagsApi	delete_global_tag	DELETE /api/v1/admin/globalTags/{uuid}	Delete a global tag
GlobalTagsApi	get_all_global_tags	GET /api/v1/globalTags	Retrieve all global tags
GlobalTagsApi	update_global_tag	PUT /api/v1/admin/globalTags/{uuid}	Update a global tag
HostsApi	create_host	POST /api/v1/workspaces/{uuid}/hosts	Manually add a host
HostsApi	get_all_hosts	POST /api/v1/workspaces/{uuid}/hosts/all	Retrieve all hosts.
HostsApi	get_host	GET /api/v1/workspaces/{w_uuid}/hosts/{h_uuid}	Retrieve all information about a single host
HostsApi	update_host	PUT /api/v1/workspaces/{w_uuid}/hosts/{h_uuid}	Update a host
LeechManagementApi	create_leech	POST /api/v1/admin/leeches	Create a leech
LeechManagementApi	delete_leech	DELETE /api/v1/admin/leeches/{uuid}	Delete a leech by its uuid
LeechManagementApi	gen_leech_config	GET /api/v1/admin/leeches/{uuid}/cert	Generate a new config for the leech
LeechManagementApi	get_all_leeches	GET /api/v1/admin/leeches	Retrieve all leeches
LeechManagementApi	get_leech	GET /api/v1/admin/leeches/{uuid}	Retrieve a leech by its id
LeechManagementApi	update_leech	PUT /api/v1/admin/leeches/{uuid}	Update a leech by its id
OAuthApi	accept	GET /api/v1/oauth/accept/{uuid}	Endpoint visited by user to grant a requesting application access
OAuthApi	deny	GET /api/v1/oauth/deny/{uuid}	Endpoint visited by user to deny a requesting application access
OAuthApi	info	GET /api/v1/oauth/info/{uuid}	Queried by the frontend to display information about the oauth request to the user
OAuthApplicationApi	create_oauth_app	POST /api/v1/admin/applications	Create a new application
OAuthApplicationApi	delete_oauth_app	DELETE /api/v1/admin/applications/{uuid}	Delete an application
OAuthApplicationApi	get_all_oauth_apps	GET /api/v1/admin/applications
OAuthApplicationApi	get_oauth_app	GET /api/v1/admin/applications/{uuid}
OAuthApplicationApi	update_oauth_app	PUT /api/v1/admin/applications/{uuid}	Update an application
OAuthDecisionsApi	get_decisions	GET /api/v1/oauthDecisions	Retrieve a user's remembered oauth decisions
OAuthDecisionsApi	revoke_decision	DELETE /api/v1/oauthDecisions/{uuid}	Revoke a user's remembered oauth decision
PortsApi	create_port	POST /api/v1/workspaces/{uuid}/ports	Manually add a port
PortsApi	get_all_ports	POST /api/v1/workspaces/{uuid}/ports/all	List the ports of a workspace
PortsApi	get_port	GET /api/v1/workspaces/{w_uuid}/ports/{p_uuid}	Retrieve all information about a single port
PortsApi	update_port	PUT /api/v1/workspaces/{w_uuid}/ports/{p_uuid}	Update a port
ServicesApi	create_service	POST /api/v1/workspaces/{uuid}/services	Manually add a service
ServicesApi	get_all_services	POST /api/v1/workspaces/{uuid}/services/all	List the services of a workspace
ServicesApi	get_service	GET /api/v1/workspaces/{w_uuid}/services/{s_uuid}	Retrieve all information about a single service
ServicesApi	update_service	PUT /api/v1/workspaces/{w_uuid}/services/{s_uuid}	Update a service
SettingsManagementApi	get_settings	GET /api/v1/admin/settings	Retrieve the currently active settings
SettingsManagementApi	update_settings	PUT /api/v1/admin/settings	Update the settings
UserAdminManagementApi	create_user	POST /api/v1/admin/users	Create a user
UserAdminManagementApi	delete_user	DELETE /api/v1/admin/users/{uuid}	Delete a user by its uuid
UserAdminManagementApi	get_all_users_admin	GET /api/v1/admin/users	Retrieve all users
UserAdminManagementApi	get_user	GET /api/v1/admin/users/{uuid}	Retrieve a user by its uuid
UserManagementApi	get_all_users	GET /api/v1/users	Request all users
UserManagementApi	get_me	GET /api/v1/users/me	Retrieve the own user
UserManagementApi	set_password	POST /api/v1/users/setPassword	Set a new password
UserManagementApi	update_me	PUT /api/v1/users/me	Updates the own user
WebsocketApi	websocket	GET /api/v1/ws	Start a websocket connection
WordlistApi	get_all_wordlists	GET /api/v1/wordlists	Get a list of all wordlist for the user to select from when starting an bruteforce subdomains attack
WordlistManagementApi	create_wordlist_admin	POST /api/v1/admin/wordlists	Create a new wordlist
WordlistManagementApi	delete_wordlist_admin	DELETE /api/v1/admin/wordlists/{uuid}	Delete an existing wordlist
WordlistManagementApi	get_all_wordlists_admin	GET /api/v1/admin/wordlists	Get a list of all wordlists including their paths
WordlistManagementApi	update_wordlist_admin	PUT /api/v1/admin/wordlists/{uuid}	Update an existing wordlist
WorkspaceInvitationsApi	accept_invitation	POST /api/v1/invitations/{uuid}/accept	Accept an invitation to a workspace
WorkspaceInvitationsApi	decline_invitation	POST /api/v1/invitations/{uuid}/decline	Decline an invitation to a workspace
WorkspaceInvitationsApi	get_all_invitations	GET /api/v1/invitations	Retrieve all open invitations to workspaces the currently logged-in user
WorkspaceTagsApi	create_workspace_tag	POST /api/v1/workspaces/{uuid}/tags	Create a workspace tag.
WorkspaceTagsApi	delete_workspace_tag	DELETE /api/v1/workspaces/{w_uuid}/tags/{t_uuid}	Delete a workspace tag
WorkspaceTagsApi	get_all_workspace_tags	GET /api/v1/workspaces/{uuid}/tags	Retrieve all workspace tags
WorkspaceTagsApi	update_workspace_tag	PUT /api/v1/workspaces/{w_uuid}/tags/{t_uuid}	Update a workspace tag
WorkspacesApi	create_invitation	POST /api/v1/workspaces/{uuid}/invitations	Invite a user to the workspace
WorkspacesApi	create_workspace	POST /api/v1/workspaces	Create a new workspace
WorkspacesApi	delete_workspace	DELETE /api/v1/workspaces/{uuid}	Delete a workspace by its id
WorkspacesApi	get_all_workspace_invitations	GET /api/v1/workspaces/{uuid}/invitations	Query all open invitations to a workspace
WorkspacesApi	get_all_workspaces	GET /api/v1/workspaces	Retrieve all workspaces that the executing user has access to
WorkspacesApi	get_search_results	GET /api/v1/workspaces/{w_uuid}/search/{s_uuid}	Retrieve results for a search by it's uuid
WorkspacesApi	get_searches	GET /api/v1/workspaces/{uuid}/search	Query all searches
WorkspacesApi	get_workspace	GET /api/v1/workspaces/{uuid}	Retrieve a workspace by id
WorkspacesApi	retract_invitation	DELETE /api/v1/workspaces/{w_uuid}/invitations/{i_uuid}	Retract an invitation to the workspace
WorkspacesApi	search	POST /api/v1/workspaces/{uuid}/search	Search through a workspaces' data
WorkspacesApi	transfer_ownership	POST /api/v1/workspaces/{uuid}/transfer	Transfer ownership to another account
WorkspacesApi	update_workspace	PUT /api/v1/workspaces/{uuid}	Updates a workspace by its id

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

api_key

Type: API key
API key parameter name: id
Location:

Author

git@omikron.dev

Metadata

Release files for kraken_sdk 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kraken_sdk 0.2.0
File	Size	Uploaded	Provenance
kraken_sdk-0.2.0.tar.gz	100.5 kB	Dec 11, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for kraken_sdk 0.2.0
File	Interpreter	ABI	Platform	Reset
kraken_sdk-0.2.0-py3-none-any.whl 311.2 kB Dec 11, 2023 Without provenance	Python 3	none	any	Details

Total release size: 411.8 kB

Release files / kraken_sdk-0.2.0.tar.gz

Download URL	kraken_sdk-0.2.0.tar.gz
Size	100.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`cfc64610f387dd27be9a11998a8251fc681f8781637fee1078766be43ad3caa8`
BLAKE2b-256 checksum How to use checksums	`41cd7e0e8dfc431d02883b3ebf6c50fdecf33b9427cbff0e52bf31c08e439849`
Upload date	Dec 11, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.7.1 CPython/3.11.6 Linux/6.6.5-arch1-1`

Release files / kraken_sdk-0.2.0-py3-none-any.whl

Download URL	kraken_sdk-0.2.0-py3-none-any.whl
Size	311.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4e9dab513ca5f97e178f7713788bcdd94eb35e0fa30599f1f95876e386b5b60c`
BLAKE2b-256 checksum How to use checksums	`71bdde7405222bb78b54b7a9649a0313f28866624c08fa2cd8f620d49ef895e4`
Upload date	Dec 11, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.7.1 CPython/3.11.6 Linux/6.6.5-arch1-1`

Security for kraken_sdk 0.2.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

Dec 11, 2023 2 release files No provenance

0.1.0

Dec 6, 2023 2 release files No provenance

kraken_sdk 0.2.0