Code Monkey home page Code Monkey logo

velociraptor-docs's Introduction

Documentation site for Velociraptor

This is the documentation site for Velociraptor - digging deeper!

Building this site

The site uses the static website generator Hugo.

To develop on the site:

  1. clone this repository by running the following git clone command

    git clone --recurse-submodules https://github.com/Velocidex/velociraptor-docs.git
    

    Note normal cloning will not work. You must recurse the submodules or hugo will not understand shortcodes and you will see errors such as: failed to extract shortcode: template for shortcode "children" not found

  2. Run Hugo:

    1. Run Hugo with a nativly installed version
    hugo serve
    
    1. Alternativly you can run hugo in docker as such:
    docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:alpine server
    
  3. Open your browser to http://localhost:1313.

    This will bring up a local web server where you can see your changes.

Shield: CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0

velociraptor-docs's People

Contributors

4ltern4te avatar acedef avatar ahatton-r7 avatar angry-bender avatar badbloopz avatar bmcder02 avatar carloscanto15 avatar cybiosity-syn avatar dfirjos avatar eduardomcm avatar ekt0-syn avatar ffh571 avatar fukusuket avatar mgreen27 avatar misje avatar northwavecert avatar pcnz avatar randomaccess3 avatar sam0rai avatar sbattaglia-r7 avatar scudette avatar seeps avatar svch0stz avatar tclahr avatar vxsh4d0w avatar weslambert avatar y0sh1mitsu avatar yamatosecurity avatar ydkhatri avatar zanegittins avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

velociraptor-docs's Issues

Is this different than https://github.com/Velocidex/velociraptor/blob/091d96634d8613d76ffcd9d1eabe442252cac71e/artifacts/definitions/Windows/Applications/NirsoftBrowserViewer.yaml#L3 ?

          Is this different than https://github.com/Velocidex/velociraptor/blob/091d96634d8613d76ffcd9d1eabe442252cac71e/artifacts/definitions/Windows/Applications/NirsoftBrowserViewer.yaml#L3 ?

Should we just incorporate it there?

Originally posted by @scudette in #654 (comment)

Yes. it may be similar. could be incorporated.
FileActivityWatch is brand new and doesn't have a similar yaml

Audit artifact exchange to remove older artifacts

The number of artifacts in the exchange is growing and we need to trim them a bit in order to increase quality.

The following guidelines make sense

  1. Artifacts the specifically search in event logs should be merged into the sigma project
  2. Artifacts the look in sqlite files should be merged in sqlitehunter
  3. Artifacts that run external tools should pin tool hashes
  4. Artifacts that look for specific threats should be removed once the threat is too old (e.g. log4j)

DetectRaptor.yaml - find zip URL fail

The first http request is used to first check for version timestamp and find zip url of DetectRaptor package.

The first request is set to https://api.github.com/repos/mgreen27/DetectRaptor/releases.

I don't know if it's due to an update on GitHub side, but right now the Server.ImportDetectRaptor server artifact fails to execute properly because GitHub API wants the User-Agent header to be set. Below is the corresponding Log:

Request forbidden by administrative rules. Please make sure your request has a User-Agent header (https://docs.github.com/en/rest/overview/resources-in-the-rest-api#user-agent-required). Check https://developer.github.com for other possible causes.

So I propose to pass a user-agent value in the user_gent argument of http_client() on the first call (PR to come). That way the forbidden error is no longer returned and the import is successful.

FYI: CIS-CAT Lite

Hello! This isn't really an "issue" or "bug", but I came across your documentation regarding the use of CIS-CAT Lite here: https://docs.velociraptor.app/exchange/artifacts/pages/windows.audit.ciscat_lite/.

I wanted to let you know you could actually automate the process and avoid having to register with CIS by using their publicly available API to download the latest version of CIS-CAT Lite. Documentation for that API is at https://ssapi.docs.cisecurity.org/en/latest/endpoints/cis-cat-lite-latest.html.

I am sure automating the full process of downloading, unzipping and running CIS-CAT Lite, and uploading the HTML report could be a helpful addition to your tools. Hope it helps!

Error on Generic.Detection.Log4jVulnHunter

I'm sorry if this is not the place where this issue should be opened

But when using Velociraptor v0.7.1-1, both Generic.Detection.Log4jVulnHunter and Generic.Detection.log4jRCE uses the FullPath arg in

/*Generic.Detection.Log4jVulnHunter*/
FROM Recurse(File=FullPath, OriginalFile=FullPath,Container=FullPath,RecursionRounds=0)

/*Generic.Detection.log4jRCE*/
LET files = SELECT FullPath, Name, Size , Mtime, Atime, Ctime, Btime

I replaced FullPath by OSPath locally and it solved this problem !

Configuration details within Deployment section

Hi Guys!
I miss some kind of a reference page about the Config file in documentation.
I've started to create it. But before I proceed, I would like to know your thoughts about it.
Here is 2 screenshots how I see it 1, 2
I used this file as a source, but I'm not sure if it actually enough. For me, it is more convenient to show examples and attach links within the Documentation.

Do we need it or such reference can be created in some automated way with fewer efforts?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.