Package: faraday-cli
Faraday on the terminalUse faraday directly from your favorite terminalfaraday-cli is the official client that make automating your security workflows, easier.Install from pippip install faraday-cliInstall from sourcegitclonehttps://github.com/infobyte/faraday-cli.gitcdfaraday-cli
pipinstall.DocumentationFor more info you can check ourdocumentationUse it like a commandLoginConfigure auth for farday-cli$faraday-cliauthCreate a workspaceWhen you create a workspace by default is selected as active, unless you use the "-d" flag$faraday-cliworkspacecreatesome_name
✔Createdworkspace:some_nameSelect active workspace$faraday-cliworkspaceselectsome_name
✔Selectedworkspace:some_nameList workspaces$faraday-clilist_ws
NAMEHOSTSSERVICESVULNSACTIVEPUBLICREADONLY
-----------------------------------------------------------
some_name141339TrueFalseFalseList hosts of a workspace$faraday-clihostlistIDIPOSHOSTNAMESSERVICESVULNS
------------------------------------------------------574127.0.0.1unknown13566127.0.0.10unknown13569127.0.0.11unknown13568127.0.0.12unknown13570127.0.0.13unknown13576127.0.0.2unknown13565127.0.0.3unknown13572127.0.0.4unknown13573127.0.0.5unknown13567127.0.0.6unknown13571127.0.0.7unknown13564127.0.0.8unknown13575127.0.0.9unknown1359058.76.184.4unknownwww.googlec.com0-Get host$faraday-clihostget574$faraday-clihostget574Host:IDIPOSHOSTNAMESOWNEROWNEDVULNS
----------------------------------------------------574127.0.0.1unknownfaradayFalse3Services:IDNAMEDESCRIPTIONPROTOCOLPORTVERSIONSTATUSVULNS
---------------------------------------------------------------2638sshtcp22unknownopen2Vulnerabilities:IDNAMESEVERITYSTATUSCONFIRMEDTOOL
---------------------------------------------------------------------------------13509SSHWeakEncryptionAlgorithmsSupportedMEDopenedFalseOpenvas13510SSHWeakMACAlgorithmsSupportedLOWopenedFalseOpenvas13511TCPtimestampsLOWopenedFalseOpenvasCreate hosts$faraday-clihostcreate-d\''[{"ip": "stan.local", "description": "some server"}]'\'Or pipe it$echo'[{"ip": "1.1.1.5", "description": "some text"}]'|faraday-clihostcreate--stdinThe escaping of the single quotes (\') is only needed when using it as a command.
In the shell or using pipes it not necessaryImport vulnerabilities from tool report$faraday-clitoolreport"/path/to/report.xml"Import vulnerabilities from command$faraday-cliping-c1www.google.comList agents$faraday-cliagentlistidnameactivestatusexecutors
---------------------------------------8internalTrueonlinenmapRun executor$faraday-cliagentrun-a1-enmap-p\''{"target": "www.google.com"}'\'Runexecutor:internal/nmap[{'successful':True}]Use it like a shellFaraday-cli can be used as a shell and have all the same commands you have as a cliUse casesContinuous scan your assets with faradayFor example run nmap for all the hosts in faraday that listen on the 443 port and import the results back to faraday$faraday-clihostlist--port443-ip|nmap-iL--oX/tmp/nmap.xml&&faraday-cliprocess_report/tmp/nmap.xmlScan your subdomainsUse a tool like assetfinder to do a domains lookup, scan them with nmap and send de results to faraday$assetfinder-subs-onlyexample.com|sort|uniq|awk'BEGIN { ORS = ""; print " {\"target\":\""}{ printf "%s%s", separator, $1, $2separator = ","}END { print "\"}" }'|faraday-cliagentrun-a1-enmap--stdin2.1.11 [Feb 26th, 2024]:[FIX] Fix workspace activation. #872.1.10 [Apr 5th, 2023]:[MOD] Change resolve_hostname to false for default, add the --resolve-hostname flag for host create and add --force flag to tool run to process the output of the command regardless of the return code. #792.1.9 [Dec 15th, 2022]:[ADD] Add vuln delete vuln-id.2.1.8 [OCt 27th, 2022]:[ADD] New method to update existing vuln.2.1.7 [Sep 13th, 2022]:Add personal status.Replace the apply_tag function with plugins parameters.Update agents docs.2.1.6 [Jul 26th, 2022]:Remove workspace from get/list agent and add it to run agent.2.1.5 [Jun 10th, 2022]:Now shell mode doesn't exit if it has faraday's url and token but the server is down.Support multiple tags on import and run.Update gifs of readme.2.1.4 [May 23th, 2022]:Check if token is valid on start in shell mode.2.1.3 [May 20th, 2022]:Now is possible to doesn't resolve hostname by changing resolve_hostname parameter.Fix the colors in Severity Stats.2.1.2 [Jan 11th, 2022]:Update Documentation.2.1.1 [Dec 13th, 2021]:ADD setting to enable/disable auto command detection.Fix error message when a command dont generate valid output.FIX tables visualization when host has to many hostnames.Show if update is available.2.1.0 [Nov 19th, 2021]:Add fields to executive reports generation command.Add KAKER_MODE easter egg.Update plugins requirements to 1.5.62.0.2 [Aug 9th, 2021]:add --create-workspace parameter for tool commandAsk for executive report template if not providedAdd for executor parameters if not provided[FIX] Bug using an invalid executor nameUpdate readme to fix some examples2.0.1 [Jun 29th, 2021]:[FIX] Show help if no subcommand is provided2.0.0 [Jun 29th, 2021]:[MOD] Change commands to verbsEnable and disable WorkspacesFix to use cmd2 2.0 and update requirementsShow message if license is expired[MOD] Change to V3 api of faradayAdd command to upload evidence to vuln1.1.1 [Jun 9th, 2021]:Fix to use cmd2 2.0 and update requirementsShow message if license is expired[MOD] Change to V3 api of faraday1.1.0 [Apr 16th, 2021]:Add new command to process a tool executionAdd command to list vulnerabilitiesAdd versions to dependenciesAdd setting to ignore INFO vulnsShow only active workspaces by default unless you use the --show-inactive parameter[MOD] Add support for tagsUpdate faraday_plugins version dependencyFix create_hosts docs typoShow user in status[MOD] Update faraday-plugins1.0.2 [Feb 17th, 2021]:ADD documentation (made with mkdocs)MOD Convert some command and help to pluralFIX Exit shell in case of invalid authorization resultFIX faraday 3.14.1 updated security lib, and make login bugged1.0.1 [Jan 4th, 2021]:Fix error in list_host command1.0.0 [Dec 28th, 2020]:Add List Services commandChange the import command/report messageAdd support for executive reportsShow in status if token is valid0.1.0 [Aug 28th, 2020]:First version released, use with caution as it is still beta phase.Access a faraday server from your CLI, your CI o any other bash interpreter.