Package: govtech-csg-xcg-securemodelpkid
govtech-csg-xcg-securemodelpkidThis package belongs to theeXtended Code Guardrails (XCG)project, which consists of a series of packages that harden the Django web framework to prevent common web application vulnerabilities.Specifically, the Secure Model PKID package provides mechanisms to generate random primary keys for Django model objects, as opposed to Django's default behaviour that uses an auto-incrementing integer value. The aim of this package is to prevent IDOR vulnerabilities.Do note that the README in this repository is intentionally limited in scope and is catered towards developers. For detailed instructions on installation, usage, and community guidelines, please refer to the published documentation athttps://xcg.tech.gov.sg.Security-related mattersFor instructions on how toreport a vulnerability, refer to theofficial documentation website.Additionally,enable email alerts for security issues by "watching" this repository. The "watch" button can be found near the top right corner of this repo's home page, and there are various options for configuring notification volume. To receive security alerts, either enable notifications for"All Activity"or"Custom -> Security alerts".Installing development dependenciesBefore building or testing the package, or committing changes, install the development dependencies into a virtual environment:# In the project root directorypython-mvenv.venv&&source.venv/bin/activate
pipinstall-rrequirements-dev.txtBuildingThe package can be built usingbuildas the build frontend andsetuptoolsas the build backend.Run the build command below:# In the project root directorypython-mbuild.This creates a directory nameddist/, which should contain 2 files:A.whl(wheel) file, which is abinary distribution formatfor Python packagesA.tar.gzfile, which is asource distribution formatfor Python packagesTo view the source files included in the source distribution, use thetarutility as follows:tar--list-fdist/<filename>.tar.gzTo install the package directly from either distribution files:pipinstall<name_of_distribution_file>TestingAs the tests for this package use multiple variants of the Django settings module, aconvenience scripthas been provided for ease of running all test methods. Execute the tests using the commands below:pipinstall-e.# Performs an "editable install" of the govtech-csg-xcg-securemodelpkid packagecdtests
/bin/bashrun_all_tests.shRunning pre-commit hooksNote: This section is only relevant if you intend to contribute codeThis project uses thepre-committoolto run Git pre-commit hooks for linting and code quality checks. Thepre-committool itself should have been installed along with thedevelopment dependencies. After cloning the repositoryfor the first time, run the command below to "install" the Git hooks:pre-commitinstallThe command above creates a file.git/hooks/pre-commit, which defines the shell commands to run before any Git commit is created.Subsequently, any invocation ofgit commitwill trigger the commands, rejecting the commit if there are linting errors. Issues should be automatically fixed, but you will need to re-stage the changes before attempting the commit again.For a list of hooks run bypre-commit, see itsconfiguration file.