Skip to content

Latest commit

 

History

History
111 lines (82 loc) · 6.26 KB

README.md

File metadata and controls

111 lines (82 loc) · 6.26 KB
Raw

#New Relic Security Agent for Go under the New Relic Software License v1.0 Software Notice.

Repo : newrelic/csec-go-agent
Package Name: newrelic_security_agent

The New Relic Security Agent for Go under the New Relic Software License v1.0 Software Notice.This module enables instrumentation of golang application for interactive application security analysis (IAST) and exposes exploitable vulnerabilities. The IAST capability should only be used in pre-production environments as the application is tested for real exploitable vulnerabilities.

Installation

Compatibility and Requirements

For the latest version of the agent, Go 1.18+ is required. Linux, MacOS, and Windows are supported.

Installing and using the Go agent

To install the agent, follow the instructions in our GETTING_STARTED document.

Getting Started

examples/sample-vulnerable-application/main.go is an example that will appear as "Example App" in your New Relic applications list. To run it:

env NEW_RELIC_LICENSE_KEY=__YOUR_NEW_RELIC_LICENSE_KEY__LICENSE__ \
    go run examples/sample-vulnerable-application/main.go

Support Matrix

Go Versions

For the latest version of the agent, Go 1.17+ is required.

Service Frameworks

  • net/http
  • gin-gonic/gin
  • gorilla/mux
  • google.golang.org/grpc
  • labstack/echo
  • julienschmidt/httprouter
  • micro/go-micro
  • valyala/fasthttp

Databases

  • database/sql
  • mattn/go-sqlite3
  • jmoiron/sqlx
  • go-mssqldb
  • mongodb/mongo-go-driver
  • go-sql-driver/mysql
  • lib/pq
  • jackc/pgx
  • jackc/pgx/v5

###Supported Vulnerabilities

  • Remote Code Execution
  • SQL Injection
  • NoSQL Injection
  • Stored XSS
  • Reflected XSS
  • File Access
  • SSRF
  • Application Integrity Violation
  • LDAP Injection
  • XPath Injection
  • XQuery Injection
  • JavaScript Code Injection

Instrumentation Packages

The following instrumentation packages extend the base newrelic csec-go-agent package to support the following frameworks and libraries.

Based on additional packages imported by the user application, add suitable imports.

Service Frameworks

Project Instrumentation Package
antchfx/htmlquery instrumentation/csec_antchfx_htmlquery
antchfx/jsonquery instrumentation/csec_antchfx_jsonquery
antchfx/xmlquery instrumentation/csec_antchfx_xmlquery
antchfx/xpath instrumentation/csec_antchfx_xpath
augustoroman/v8 instrumentation/csec_augustoroman_v8
google.golang.org/grpc instrumentation/csec_grpc
ldap/v3 instrumentation/csec_ldap_v3
mongo-driver/mongo instrumentation/csec_mongodb_mongo
robertkrimen/otto instrumentation/csec_robertkrimen_otto
valyala/fasthttp instrumentation/csec_valyala_fasthttp

Support

New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. You can find this project’s topic/threads here: Add the url for the support thread here: https://forum.newrelic.com/s/

Contribute

Any feedback provided to New Relic about the New Relic csec-go-agent, including feedback provided as source code, comments, or other copyrightable or patentable material, is provided to New Relic under the terms of the Apache Software License, version 2. If you do not provide attribution information or a copy of the license with your feedback, you waive the performance of those requirements of the Apache License with respect to New Relic. The license grant regarding any feedback is irrevocable and persists past the termination of the New Relic Software License v1.0. Keep in mind that when you submit a pull request or other feedback, you’ll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions drop us an email at opensource@newrelic.com.

A note about vulnerabilities

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.

If you would like to contribute to this project, review these guidelines.

License

newrelic/csec-go-agent is licensed under the New Relic Software License v1.0 The newrelic/csec-go-agent also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.