├── .github └── workflows │ └── ci.yml ├── .gitignore ├── LICENSE.txt ├── README.md ├── debian ├── changelog ├── control ├── copyright ├── rules └── source │ ├── format │ └── options ├── requirements.txt ├── scarlet_shark_client ├── __init__.py ├── client.py └── clients │ ├── __init__.py │ ├── abstract.py │ └── v04_client.py └── setup.py /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Upload to PyPI 2 | 3 | on: 4 | release: 5 | types: [created] 6 | workflow_dispatch: 7 | 8 | jobs: 9 | upload: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | 14 | - uses: actions/setup-python@v2 15 | with: 16 | python-version: 3.8 17 | 18 | - name: "Installs dependencies" 19 | run: | 20 | python3 -m pip install --upgrade pip 21 | python3 -m pip install setuptools wheel twine 22 | 23 | - name: "Builds and uploads to PyPI" 24 | run: | 25 | python3 setup.py sdist bdist_wheel 26 | python3 -m twine upload dist/* 27 | env: 28 | TWINE_USERNAME: __token__ 29 | TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }} -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | tests.py 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # scarlet-shark-python 2 | Scarlet Shark REST API Python client. 3 | 4 | ## Installation 5 | ``` 6 | pip install scarlet-shark-client 7 | ``` 8 | 9 | ## Usage example 10 | 11 | ```python 12 | from scarlet_shark_client.client import ClientFactory 13 | 14 | client = ClientFactory.get_client('', api_version='v0.4', print_json=True) 15 | result = client.search_domain(domain='scarletshark.com') 16 | ``` 17 | prints 18 | ```json 19 | { 20 | "age": 4043, 21 | "associated_urls": [], 22 | "classification": "security", 23 | "disclosure_email": "unknown", 24 | "domain": "scarletshark.com", 25 | "domain_description": "", 26 | "ip": "40.[redacted]", 27 | "reference_url": "", 28 | "registered": "2012-04-02", 29 | "service": { 30 | "service_email": "", 31 | "service_id": 0, 32 | "service_name": "unknown", 33 | "service_trust": "unknown", 34 | "service_type": "unknown", 35 | "service_url": "" 36 | }, 37 | "tags": [ 38 | "security" 39 | ], 40 | "threat_actor_aliases": [], 41 | "threat_actor_id": 0, 42 | "threat_classification": "safe", 43 | "threat_explanation": "The domain is considered to be safe and it hosts no known malicious content.", 44 | "tracking_domain": false 45 | } 46 | ``` 47 | 48 | ## Supported actions 49 | ### API version 0.4 50 | * search_dns 51 | * search_domain 52 | * search_email 53 | * search_hash 54 | * search_ip 55 | * search_network 56 | * search_threat_actors 57 | * search_threat_tools 58 | * search_url -------------------------------------------------------------------------------- /debian/changelog: -------------------------------------------------------------------------------- 1 | python3-scarlet-shark-client (1.0.5) UNRELEASED; urgency=medium 2 | 3 | * Fix URL encoding of array parameters 4 | 5 | -- U+039b Tue, 23 May 2023 11:16:56 +0200 6 | 7 | python3-scarlet-shark-client (1.0.4) unstable; urgency=medium 8 | 9 | * Initial release. 10 | 11 | -- U+039b Wed, 10 May 2023 12:57:58 +0200 12 | -------------------------------------------------------------------------------- /debian/control: -------------------------------------------------------------------------------- 1 | Source: python3-scarlet-shark-client 2 | Section: misc 3 | Priority: optional 4 | Maintainer: U+039b 5 | Build-Depends: 6 | debhelper-compat (= 13), 7 | quilt, 8 | dh-python, 9 | python3-all, 10 | python3-setuptools, 11 | Standards-Version: 4.5.1 12 | Homepage: https://github.com/PiRogueToolSuite/scarlet-shark-python 13 | 14 | Package: python3-scarlet-shark-client 15 | Architecture: all 16 | Depends: ${misc:Depends}, 17 | ${python3:Depends}, 18 | python3-requests, 19 | Description: Scarlet Shark REST API Python client. -------------------------------------------------------------------------------- /debian/copyright: -------------------------------------------------------------------------------- 1 | Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 2 | Upstream-Name: scarlet-shark-python 3 | Upstream-Contact: U+039b hello@pts-project.org 4 | Source: https://github.com/PiRogueToolSuite/scarlet-shark-python 5 | 6 | Files: * 7 | Copyright: 2023 U+039b 8 | Defensive Lab Agency 9 | License: GPL-3.0+ 10 | This program is free software: you can redistribute it and/or modify 11 | it under the terms of the GNU General Public License as published by 12 | the Free Software Foundation, either version 3 of the License, or 13 | (at your option) any later version. 14 | . 15 | This package is distributed in the hope that it will be useful, 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | GNU General Public License for more details. 19 | . 20 | You should have received a copy of the GNU General Public License 21 | along with this program. If not, see . 22 | . 23 | On Debian systems, the complete text of the GNU General 24 | Public License version 3 can be found in "/usr/share/common-licenses/GPL-3". -------------------------------------------------------------------------------- /debian/rules: -------------------------------------------------------------------------------- 1 | #! /usr/bin/make -f 2 | 3 | export PYBUILD_NAME=scarlet-shark-client 4 | %: 5 | dh $@ --with quilt,python3 --buildsystem=pybuild 6 | 7 | override_dh_builddeb: 8 | dh_builddeb -- -Zxz 9 | 10 | # Shipped in the tarball, modified after a build: 11 | override_dh_clean: 12 | dh_clean 13 | rm -rf scarlet_shark_client.egg-info/ 14 | -------------------------------------------------------------------------------- /debian/source/format: -------------------------------------------------------------------------------- 1 | 3.0 (native) -------------------------------------------------------------------------------- /debian/source/options: -------------------------------------------------------------------------------- 1 | extend-diff-ignore="^[^/]+.egg-info/" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.29.0 2 | -------------------------------------------------------------------------------- /scarlet_shark_client/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PiRogueToolSuite/scarlet-shark-python/95c030e569cd7aa324438716bcb38f1b1e438173/scarlet_shark_client/__init__.py -------------------------------------------------------------------------------- /scarlet_shark_client/client.py: -------------------------------------------------------------------------------- 1 | from scarlet_shark_client.clients.v04_client import ScarletSharkClient as V04ScarletSharkClient 2 | from scarlet_shark_client.clients.abstract import ScarletSharkClient 3 | 4 | API_CLIENTS = { 5 | 'v0.4': V04ScarletSharkClient, 6 | } 7 | 8 | 9 | class ClientFactory: 10 | @staticmethod 11 | def get_client(api_key: str, api_version: str = 'v0.4', print_json=False) -> ScarletSharkClient: 12 | if api_version not in API_CLIENTS: 13 | raise Exception(f'No Scarlet Shark client is available for the given version {api_version}') 14 | return API_CLIENTS[api_version](api_key, print_json) 15 | 16 | @staticmethod 17 | def get_supported_versions(): 18 | return list(API_CLIENTS.keys()) 19 | -------------------------------------------------------------------------------- /scarlet_shark_client/clients/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PiRogueToolSuite/scarlet-shark-python/95c030e569cd7aa324438716bcb38f1b1e438173/scarlet_shark_client/clients/__init__.py -------------------------------------------------------------------------------- /scarlet_shark_client/clients/abstract.py: -------------------------------------------------------------------------------- 1 | from abc import ABC, abstractmethod 2 | from typing import Optional 3 | from urllib.parse import urlencode 4 | 5 | import requests 6 | 7 | 8 | class ScarletSharkClient(ABC): 9 | version: str 10 | api_actions: dict = {} 11 | api_key: str 12 | print_json = False 13 | 14 | def __init__( 15 | self, api_key: str, print_json: bool = False): 16 | self.api_key = api_key 17 | self.print_json = print_json 18 | 19 | def _resolve_url(self, action_name: str, params) -> str: 20 | if action_name not in self.api_actions: 21 | raise Exception(f'The action [{action_name}] is not supported') 22 | query_parameters: dict = {} 23 | for k, v in params.items(): 24 | if k != 'self' and v: 25 | key = k 26 | if k == 'ip' and action_name == 'search_ip': 27 | key = 'ips[]' 28 | elif k == 'email' and action_name == 'search_email': 29 | key = 'emails[]' 30 | elif k == 'url' and action_name == 'search_url': 31 | key = 'urls[]' 32 | query_parameters[key] = v 33 | if not query_parameters: 34 | raise Exception(f'At least query parameter has to be specified in [{params}]') 35 | endpoint = self.api_actions[action_name] 36 | query_string = urlencode(query_parameters) 37 | return f'{self.version}{endpoint}?{query_string}' 38 | 39 | def _prepare_request(self, uri: str): 40 | headers = { 41 | 'Authorization': f'Bearer {self.api_key}' 42 | } 43 | base_url = 'https://api.scarletshark.com/' 44 | url = f'{base_url}{uri}' 45 | response = requests.get(url, headers=headers) 46 | if response.status_code == 200: 47 | r = response.json() 48 | if int(r.get('result_code', -1)) < 0: 49 | raise Exception(r.get('result').get('message')) 50 | result = r.get('result') 51 | if self.print_json: 52 | import json 53 | print(json.dumps(result, indent=2, sort_keys=True)) 54 | return result 55 | return None 56 | 57 | @abstractmethod 58 | def search_dns( 59 | self, 60 | ip: Optional[str] = None, 61 | hostname: Optional[str] = None, 62 | nonce: Optional[int] = None) -> Optional[dict]: 63 | """ 64 | Returns known hostname and IP associations from the Scarlet Shark database. These associations are mostly active IP lookups. 65 | :param ip: String [optional] - IP address to find hostnames for 66 | :param hostname: String [optional] - hostname to find IPs for 67 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 68 | :return: Returns known hostname and IP associations from the Scarlet Shark database 69 | """ 70 | pass 71 | 72 | @abstractmethod 73 | def search_domain( 74 | self, 75 | domain: str, 76 | nonce: Optional[int] = None) -> Optional[dict]: 77 | """ 78 | Returns information on the given domain. 79 | :param domain: String - The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format 80 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 81 | :return: Returns information on the given domain. 82 | """ 83 | pass 84 | 85 | @abstractmethod 86 | def search_email( 87 | self, 88 | email: str, 89 | nonce: Optional[int] = None) -> Optional[dict]: 90 | """ 91 | Returns threat information for the given email addresses. 92 | :param email: String - Email address to search for threat data on 93 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 94 | :return: Returns threat information for the given email addresses. 95 | """ 96 | pass 97 | 98 | @abstractmethod 99 | def search_hash( 100 | self, 101 | sha256: Optional[str] = None, 102 | md5: Optional[str] = None, 103 | nonce: Optional[int] = None) -> Optional[dict]: 104 | """ 105 | Returns information on either a SHA256 or a MD5 hash. 106 | :param sha256: String [optional] - The SHA256 hash to search for 107 | :param md5: String [optional] - The MD5 hash to search for 108 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 109 | :return: Returns information on either a SHA256 or a MD5 hash. 110 | """ 111 | pass 112 | 113 | @abstractmethod 114 | def search_ip( 115 | self, 116 | ip: str, 117 | context: Optional[str] = None, 118 | time_period: Optional[int] = None, 119 | time_zone: Optional[str] = None, 120 | nonce: Optional[int] = None) -> Optional[dict]: 121 | """ 122 | Looks up information for an IP and any threat intel information about that IP. 123 | :param ip: String - v4 or v6 IP address 124 | :param context: String [optional] – Possible values: [user_activity, none] - The context of the IP look up. This helps give a more accurate threat classification. 125 | :param time_period: Integer - The number of days to show security issues for. 126 | :param time_zone: String [optional] - PHP Time Zone Strings. Results will be returned in the given time zone. UTC is the default. See: https://www.php.net/manual/en/timezones.php 127 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 128 | :return: Looks up information for an IP and any threat intel information about that IP 129 | """ 130 | pass 131 | 132 | @abstractmethod 133 | def search_network( 134 | self, 135 | ip: str = None, 136 | nonce: Optional[int] = None) -> Optional[dict]: 137 | """ 138 | Looks up information network information about a given IP. 139 | :param ip: String - v4 or v6 IP address 140 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 141 | :return: Looks up information network information about a given IP 142 | """ 143 | pass 144 | 145 | @abstractmethod 146 | def search_threat_actors( 147 | self, 148 | query: Optional[str] = None, 149 | threat_actor_id: Optional[int] = None, 150 | vertical: Optional[str] = None, 151 | nonce: Optional[int] = None) -> Optional[dict]: 152 | """ 153 | Returns information about a given threat actor or threat actors targeting a given vertical. 154 | :param query: String [optional] - Search string to match against threat actor aliases 155 | :param threat_actor_id: Integer [optional] - The Scarlet Shark threat_actor_id to search by 156 | :param vertical: String [optional] - The vertical to search by 157 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 158 | :return: Information about a given threat actor or threat actors targeting a given vertical 159 | """ 160 | pass 161 | 162 | @abstractmethod 163 | def search_threat_tools( 164 | self, 165 | query: Optional[str] = None, 166 | threat_actor_id: Optional[int] = None, 167 | nonce: Optional[int] = None) -> Optional[dict]: 168 | """ 169 | Returns information about a given threat tool. The threat tool can be malware or a legitimate tool. 170 | :param query: String [optional] - Search string to match against threat tool aliases 171 | :param threat_actor_id: Integer [optional] - The Scarlet Shark threat_tool_id to search by 172 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 173 | :return: Information about a given threat tool. The threat tool can be malware or a legitimate tool. 174 | """ 175 | pass 176 | 177 | @abstractmethod 178 | def search_url( 179 | self, 180 | url: str, 181 | nonce: Optional[int] = None) -> Optional[dict]: 182 | """ 183 | Looks up threat information for the given URL. 184 | :param url: String - URL to search for threat data on. 185 | :param nonce: Integer [optional] - A nonce that is returned, if provided in the request 186 | :return: Looks up threat information for the given URL 187 | """ 188 | pass 189 | -------------------------------------------------------------------------------- /scarlet_shark_client/clients/v04_client.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from typing import Optional 3 | 4 | from scarlet_shark_client.clients.abstract import ScarletSharkClient as AbstractClient 5 | 6 | 7 | class ScarletSharkClient(AbstractClient): 8 | version: str = 'v0.4' 9 | api_actions: dict = { 10 | 'search_dns': '/search_dns.php', 11 | 'search_domain': '/search_domain.php', 12 | 'search_email': '/search_email.php', 13 | 'search_hash': '/search_hash.php', 14 | 'search_ip': '/search_ip.php', 15 | 'search_network': '/search_network.php', 16 | 'search_threat_actors': '/search_threat_actors.php', 17 | 'search_threat_tools': '/search_threat_tools.php', 18 | 'search_url': '/search_url.php', 19 | } 20 | 21 | def search_dns( 22 | self, 23 | ip: Optional[str] = None, 24 | hostname: Optional[str] = None, 25 | nonce: Optional[int] = None) -> Optional[dict]: 26 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 27 | return self._prepare_request(uri) 28 | 29 | def search_domain( 30 | self, 31 | domain: str, 32 | nonce: Optional[int] = None) -> Optional[dict]: 33 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 34 | return self._prepare_request(uri) 35 | 36 | def search_email( 37 | self, 38 | email: str, 39 | nonce: Optional[int] = None) -> Optional[dict]: 40 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 41 | return self._prepare_request(uri) 42 | 43 | def search_hash( 44 | self, 45 | sha256: Optional[str] = None, 46 | md5: Optional[str] = None, 47 | nonce: Optional[int] = None) -> Optional[dict]: 48 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 49 | return self._prepare_request(uri) 50 | 51 | def search_ip( 52 | self, 53 | ip: str, 54 | context: Optional[str] = None, 55 | time_period: Optional[int] = None, 56 | time_zone: Optional[str] = None, 57 | nonce: Optional[int] = None) -> Optional[dict]: 58 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 59 | return self._prepare_request(uri) 60 | 61 | def search_network( 62 | self, 63 | ip: str = None, 64 | nonce: Optional[int] = None) -> Optional[dict]: 65 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 66 | return self._prepare_request(uri) 67 | 68 | def search_threat_actors( 69 | self, 70 | query: Optional[str] = None, 71 | threat_actor_id: Optional[int] = None, 72 | vertical: Optional[str] = None, 73 | nonce: Optional[int] = None) -> Optional[dict]: 74 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 75 | return self._prepare_request(uri) 76 | 77 | def search_threat_tools( 78 | self, 79 | query: Optional[str] = None, 80 | threat_actor_id: Optional[int] = None, 81 | nonce: Optional[int] = None) -> Optional[dict]: 82 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 83 | return self._prepare_request(uri) 84 | 85 | def search_url( 86 | self, 87 | url: str, 88 | nonce: Optional[int] = None) -> Optional[dict]: 89 | uri = self._resolve_url(sys._getframe().f_code.co_name, locals()) 90 | return self._prepare_request(uri) 91 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import sys 4 | 5 | from setuptools import setup, find_packages 6 | 7 | 8 | if sys.version_info.major == 3 and sys.version_info.minor < 3: 9 | print('Unfortunately, your python version is not supported!\n Please upgrade at least to python 3.3!') 10 | sys.exit(1) 11 | 12 | # read the contents of your README file 13 | from pathlib import Path 14 | pwd = Path(__file__).parent 15 | long_description = (pwd / "README.md").read_text() 16 | 17 | install_requires = [ 18 | 'requests==2.29.0' 19 | ] 20 | 21 | setup( 22 | name='scarlet-shark-client', 23 | version='1.0.5', 24 | description='Scarlet Shark REST API Python client', 25 | long_description=long_description, 26 | long_description_content_type='text/markdown', 27 | author='U+039b', 28 | author_email='esther@pts-project.org', 29 | url='https://github.com/PiRogueToolSuite/scarlet-shark-python', 30 | packages=find_packages(exclude=['*.tests', '*.tests.*', 'test*', 'tests']), 31 | install_requires=install_requires, 32 | classifiers=[ 33 | 'Development Status :: 3 - Alpha', 34 | 'License :: OSI Approved :: GNU Affero General Public License v3', 35 | 'Natural Language :: English', 36 | 'Topic :: Security', 37 | 'Topic :: Utilities', 38 | ] 39 | ) 40 | --------------------------------------------------------------------------------