Package: simplesecurity
SimpleSecurityCombine multiple popular python security tools and generate reports or output
into different formatsPlugins (these require the plugin executable in the system path. e.g. bandit
requires bandit to be in the system path...)banditsafetydodgydlintsemgrepFormatsansi (for terminal)jsonmarkdowncsvsarifExample UseSee below for the output if you runsimplesecurityin this directoryHelp$simplesecurity--help
usage:simplesecurity[-h][--scan-dirSCAN_DIR][--formatFORMAT][--pluginPLUGIN][--fileFILE][--levelLEVEL][--confidenceCONFIDENCE][--no-colour][--high-contrast][--fast][--zero]Combinemultiplepopularpythonsecuritytoolsandgeneratereportsoroutput
intodifferentformats...

options:-h,--helpshowthishelpmessageandexit--scan-dirSCAN_DIR,-sSCAN_DIRPassapathtothescandirectory(optional)--formatFORMAT,-fFORMATOutputformat.Oneofansi,json,markdown,csv.default=ansi--pluginPLUGIN,-pPLUGINPlugintouse.Oneofbandit,safety,dodgy,dlint,semgrep,all,default=all--fileFILE,-oFILEFilenametowriteto(omitforstdout)--levelLEVEL,-lLEVELMinimumseverity/leveltoshow--confidenceCONFIDENCE,-cCONFIDENCEMinimumconfidencetoshow--no-colour,-zNoANSIcolours--high-contrast,-ZHighcontrastcolours--fast,--skipSkiplongrunningjobs.Willomitpluginswithlongruntime(appliesto-pallonly)--zero,-0ReturnnonzeroexitcodeifanysecurityvulnerabilitiesarefoundYou can also import this into your own project and use any of the functions
in the DOCSTable of ContentsExample UseHelpDeveloper NotesGenerate semgrep_sec.yamlDocumentationInstall With PIPLanguage informationBuilt forInstall Python on WindowsChocolateyWindows - Python.orgInstall Python on LinuxAptDnfInstall Python on MacOSHomebrewMacOS - Python.orgHow to runWindowsLinux/ MacOSBuildingTestingDownload ProjectCloneUsing The Command LineUsing GitHub DesktopDownload Zip FileCommunity FilesLicenceChangelogCode of ConductContributingSecuritySupportRationaleDeveloper NotesGenerate semgrep_sec.yamlClonehttps://github.com/returntocorp/semgrep-rulescd tosemgrep-rules/pythondocat**/security/**/*.yaml>>semgrep_sec.yaml
cat**/security/*.yaml>>semgrep_sec.yamlFind and replacerules:with `` apart from the first instanceReformat withctrl+shift+ireplace simplesecurity/semgrep_sec.yaml with the new oneDocumentationA high-level overview of how the documentation is organized organized will help you know
where to look for certain things:TheTechnical Referencedocuments APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.Install With PIP"Slim" Build:Install bandit, dlint, dodgy, poetry, and safety with pipxpipinstallsimplesecurityOtherwise:pipinstallsimplesecurity[full]Head tohttps://pypi.org/project/SimpleSecurity/for more infoLanguage informationBuilt forThis program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11Install Python on WindowsChocolateychocoinstallpythonWindows - Python.orgTo install Python, go tohttps://www.python.org/downloads/windows/and download the latest
version.Install Python on LinuxAptsudoaptinstallpython3.xDnfsudodnfinstallpython3.xInstall Python on MacOSHomebrewbrewinstallpython@3.xMacOS - Python.orgTo install Python, go tohttps://www.python.org/downloads/macos/and download the latest
version.How to runWindowsModulepy -3.x -m [module]or[module](if module installs a script)Filepy -3.x [file]or./[file]Linux/ MacOSModulepython3.x -m [module]or[module](if module installs a script)Filepython3.x [file]or./[file]BuildingThis project useshttps://github.com/FHPythonUtils/FHMaketo automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefactsNote the functionality provided by fhmake can be approximated by the followinghandsdown--cleanup-odocumentation/reference
poetryexport-frequirements.txt--outputrequirements.txt
poetryexport-frequirements.txt--withdev--outputrequirements_optional.txt
poetrybuildfhmake auditcan be run to perform additional checksTestingFor testing with the version of python used by poetry usepoetryrunpytestAlternatively usetoxto run tests over python 3.8 - 3.11toxDownload ProjectCloneUsing The Command LinePress the Clone or download button in the top rightCopy the URL (link)Open the command line and change directory to where you wish to
clone toType 'git clone' followed by URL in step 2gitclonehttps://github.com/FHPythonUtils/SimpleSecurityMore information can be found athttps://help.github.com/en/articles/cloning-a-repositoryUsing GitHub DesktopPress the Clone or download button in the top rightClick open in desktopChoose the path for where you want and click CloneMore information can be found athttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktopDownload Zip FileDownload this GitHub repositoryExtract the zip archiveCopy/ move to the desired locationCommunity FilesLicenceMIT License
Copyright (c) FredHappyface
(See theLICENSEfor more information.)ChangelogSee theChangelogfor more information.Code of ConductOnline communities include people from many backgrounds. TheProjectcontributors are committed to providing a friendly, safe and welcoming
environment for all. Please see theCode of Conductfor more information.ContributingContributions are welcome, please see theContributing Guidelinesfor more information.SecurityThank you for improving the security of the project, please see theSecurity Policyfor more information.SupportThank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see theSupport Policyfor more information.RationaleThe rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see theRationalefor more information.