Note
This project is unfinished/unmaintained. It was created as part of self education shortly before my recent career pivot and I've not had the time to maintain it. It is somewhat higher quality that many of the older abandoned projects on my GH but there is a lot of work to do to make it functional or useful. I am keeping all of my old self-education projects public for transparancy and posterity. If you are interested in this project, please do reach out via an issue or similar as I would consider revisiting it. I have not had the time to focus on this due to family commitments and having moved away from Ivanti (I was employed by Ivanti when I started this project however it is not officially associated with Ivanti in any capacty). I do still have a reasonably deep understanding of the Security Controls project and if anyone wishes to collaborate on finishing this project I would be keen to hear so, as collaborating on OSS is something I am interested in. It is however unlikely at this time that I will revisit this project in a solo capacity due to the sheer volume of other technologies I am learning as part of my current career and family duties.
DISCLAIMER: This project is in pre-alpha stage, end users should not attempt to implement this project in live environments!
Contributers, please see CONTRIBUTIONS.md for further information about contributing.
As is customary in the modern Python world, I would highly recommend first setting up a virtual environment before installing any dependencies or the package itself. My personal preference and what I use in actual development is to simply use 'python -m venv .venv --prompt a_nice_prompt_name_here' which works nicely with vscode. Please note, the pre-commit hooks rely on the folder being called '.venv' in order to run properly on your local machine, if you intend to contribute please ensure you use '.venv'!
Installation will soon be possible using 'pip install isecapipy' once version 1.0.0 is defined and packaged. Until then, if you require to work on the project (you should only do so if you wish to contribute to the project for the time being) then you should simply git clone the repo and install dev-requirements.txt with 'pip install -r dev-requirements.txt' from the main project folder location. You can then install the package in editable mode with 'pip install -e ./isecapipy' again from the project folder.
import isecapipy
isec = isecapipy.handler(auth_type = 'kerberos', console_fqdn = 'ISEC.domain.local')
agents = isec.agents.get() # returns a list of AgentDetail instances
for agent in agents:
isecpipy.checkin(agent)
#> Sending check in request to Agent 'UWM-W10-01.UWM.LOCAL' succeeded.
#> ...It should be noted that the above example is not yet implemented, it is a placeholder for **intended** general API usage demonstration purposes only at this time.
The project is currently undergoing structural and procedural design (CI/CD), following which the below tasks will be completed:
- [] 1-1 mappings of REST API endpoints to URI dict
- [] 1-1 mappings of REST API endpoints to package level functions
- [] 1-1 mappings of all response objects to pydantic models
- [] 1-1 mappings of all json body objects to pydantic models
- [] test suit completed with >90% coverage
After this point, commits directly made to main will not be allowed, moving to a proper github style workflow as the project matures toward a 1.0.0 release.
The requirements are fairly minimal at the time of writing. Currently, no request functinality has been implimented within the package so the only real requirement is Pydantic. Once the API mappings and data serialisation models are completed, then functionality to handle http requests will be implimented, at which point further requirements will be introduced but it has not yet been decided what packages will be used. HTTPX is a potential front runner however it is also desired to allow Kerberos authentication to the console REST API which I am yet to verify using anything other than requests, however this introduces a differntiation between Windows and Linux environments as requests-kerberos is not available for Linux.
For now, if contributing however, as previously mentioned, please ensure you install dev-requirements.txt into your environment.