mirror of https://github.com/daffainfo/nuclei.git
313 lines
12 KiB
Go
313 lines
12 KiB
Go
package ssl
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"net/url"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/fatih/structs"
|
|
jsoniter "github.com/json-iterator/go"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/projectdiscovery/fastdialer/fastdialer"
|
|
"github.com/projectdiscovery/gologger"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators/extractors"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators/matchers"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/output"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/contextargs"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/expressions"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/generators"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/helpers/eventcreator"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/helpers/responsehighlighter"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/utils/vardump"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/dns"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/network/networkclientpool"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/utils"
|
|
templateTypes "github.com/projectdiscovery/nuclei/v2/pkg/templates/types"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/types"
|
|
"github.com/projectdiscovery/tlsx/pkg/tlsx"
|
|
"github.com/projectdiscovery/tlsx/pkg/tlsx/clients"
|
|
)
|
|
|
|
// Request is a request for the SSL protocol
|
|
type Request struct {
|
|
// Operators for the current request go here.
|
|
operators.Operators `yaml:",inline,omitempty"`
|
|
CompiledOperators *operators.Operators `yaml:"-"`
|
|
|
|
// description: |
|
|
// Address contains address for the request
|
|
Address string `yaml:"address,omitempty" jsonschema:"title=address for the ssl request,description=Address contains address for the request"`
|
|
// description: |
|
|
// Minimum tls version - auto if not specified.
|
|
// values:
|
|
// - "sslv3"
|
|
// - "tls10"
|
|
// - "tls11"
|
|
// - "tls12"
|
|
// - "tls13"
|
|
MinVersion string `yaml:"min_version,omitempty" jsonschema:"title=TLS version,description=Minimum tls version - automatic if not specified.,enum=sslv3,enum=tls10,enum=tls11,enum=tls12,enum=tls13"`
|
|
// description: |
|
|
// Max tls version - auto if not specified.
|
|
// values:
|
|
// - "sslv3"
|
|
// - "tls10"
|
|
// - "tls11"
|
|
// - "tls12"
|
|
// - "tls13"
|
|
MaxVersion string `yaml:"max_version,omitempty" jsonschema:"title=TLS version,description=Max tls version - automatic if not specified.,enum=sslv3,enum=tls10,enum=tls11,enum=tls12,enum=tls13"`
|
|
// description: |
|
|
// Client Cipher Suites - auto if not specified.
|
|
CiperSuites []string `yaml:"cipher_suites,omitempty"`
|
|
|
|
// cache any variables that may be needed for operation.
|
|
dialer *fastdialer.Dialer
|
|
tlsx *tlsx.Service
|
|
options *protocols.ExecuterOptions
|
|
}
|
|
|
|
// Compile compiles the request generators preparing any requests possible.
|
|
func (request *Request) Compile(options *protocols.ExecuterOptions) error {
|
|
request.options = options
|
|
|
|
client, err := networkclientpool.Get(options.Options, &networkclientpool.Configuration{})
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not get network client")
|
|
}
|
|
request.dialer = client
|
|
|
|
tlsxOptions := &clients.Options{
|
|
AllCiphers: true,
|
|
ScanMode: "auto",
|
|
Expired: true,
|
|
SelfSigned: true,
|
|
MisMatched: true,
|
|
MinVersion: request.MinVersion,
|
|
MaxVersion: request.MaxVersion,
|
|
Ciphers: request.CiperSuites,
|
|
WildcardCertCheck: true,
|
|
Retries: request.options.Options.Retries,
|
|
Timeout: request.options.Options.Timeout,
|
|
Fastdialer: client,
|
|
}
|
|
if options.Options.ZTLS {
|
|
tlsxOptions.ScanMode = "ztls"
|
|
}
|
|
tlsxService, err := tlsx.New(tlsxOptions)
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not create tlsx service")
|
|
}
|
|
request.tlsx = tlsxService
|
|
|
|
if len(request.Matchers) > 0 || len(request.Extractors) > 0 {
|
|
compiled := &request.Operators
|
|
compiled.ExcludeMatchers = options.ExcludeMatchers
|
|
compiled.TemplateID = options.TemplateID
|
|
if err := compiled.Compile(); err != nil {
|
|
return errors.Wrap(err, "could not compile operators")
|
|
}
|
|
request.CompiledOperators = compiled
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Requests returns the total number of requests the rule will perform
|
|
func (request *Request) Requests() int {
|
|
return 1
|
|
}
|
|
|
|
// GetID returns the ID for the request if any.
|
|
func (request *Request) GetID() string {
|
|
return ""
|
|
}
|
|
|
|
// ExecuteWithResults executes the protocol requests and returns results instead of writing them.
|
|
func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicValues, previous output.InternalEvent, callback protocols.OutputEventCallback) error {
|
|
address, err := getAddress(input.MetaInput.Input)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
hostname, port, _ := net.SplitHostPort(address)
|
|
|
|
requestOptions := request.options
|
|
payloadValues := make(map[string]interface{})
|
|
for k, v := range dynamicValues {
|
|
payloadValues[k] = v
|
|
}
|
|
payloadValues["Hostname"] = address
|
|
payloadValues["Host"] = hostname
|
|
payloadValues["Port"] = port
|
|
|
|
hostnameVariables := dns.GenerateVariables(hostname)
|
|
values := generators.MergeMaps(payloadValues, hostnameVariables)
|
|
variablesMap := request.options.Variables.Evaluate(values)
|
|
payloadValues = generators.MergeMaps(variablesMap, payloadValues)
|
|
|
|
if vardump.EnableVarDump {
|
|
gologger.Debug().Msgf("Protocol request variables: \n%s\n", vardump.DumpVariables(payloadValues))
|
|
}
|
|
|
|
finalAddress, dataErr := expressions.EvaluateByte([]byte(request.Address), payloadValues)
|
|
if dataErr != nil {
|
|
requestOptions.Output.Request(requestOptions.TemplateID, input.MetaInput.Input, request.Type().String(), dataErr)
|
|
requestOptions.Progress.IncrementFailedRequestsBy(1)
|
|
return errors.Wrap(dataErr, "could not evaluate template expressions")
|
|
}
|
|
addressToDial := string(finalAddress)
|
|
host, port, err := net.SplitHostPort(addressToDial)
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not split input host port")
|
|
}
|
|
|
|
response, err := request.tlsx.Connect(host, host, port)
|
|
if err != nil {
|
|
requestOptions.Output.Request(requestOptions.TemplateID, input.MetaInput.Input, request.Type().String(), err)
|
|
requestOptions.Progress.IncrementFailedRequestsBy(1)
|
|
return errors.Wrap(err, "could not connect to server")
|
|
}
|
|
|
|
requestOptions.Output.Request(requestOptions.TemplateID, address, request.Type().String(), err)
|
|
gologger.Verbose().Msgf("Sent SSL request to %s", address)
|
|
|
|
if requestOptions.Options.Debug || requestOptions.Options.DebugRequests || requestOptions.Options.StoreResponse {
|
|
msg := fmt.Sprintf("[%s] Dumped SSL request for %s", requestOptions.TemplateID, input.MetaInput.Input)
|
|
if requestOptions.Options.Debug || requestOptions.Options.DebugRequests {
|
|
gologger.Debug().Str("address", input.MetaInput.Input).Msg(msg)
|
|
}
|
|
if requestOptions.Options.StoreResponse {
|
|
request.options.Output.WriteStoreDebugData(input.MetaInput.Input, request.options.TemplateID, request.Type().String(), msg)
|
|
}
|
|
}
|
|
|
|
jsonData, _ := jsoniter.Marshal(response)
|
|
jsonDataString := string(jsonData)
|
|
|
|
data := make(map[string]interface{})
|
|
|
|
data["type"] = request.Type().String()
|
|
data["response"] = jsonDataString
|
|
data["host"] = input
|
|
data["matched"] = addressToDial
|
|
if input.MetaInput.CustomIP != "" {
|
|
data["ip"] = input.MetaInput.CustomIP
|
|
} else {
|
|
data["ip"] = request.dialer.GetDialedIP(hostname)
|
|
}
|
|
data["template-path"] = requestOptions.TemplatePath
|
|
data["template-id"] = requestOptions.TemplateID
|
|
data["template-info"] = requestOptions.TemplateInfo
|
|
for k, v := range payloadValues {
|
|
data[k] = v
|
|
}
|
|
|
|
// Convert response to key value pairs and first cert chain item as well
|
|
responseParsed := structs.New(response)
|
|
for _, f := range responseParsed.Fields() {
|
|
tag := utils.CleanStructFieldJSONTag(f.Tag("json"))
|
|
if tag == "" || f.IsZero() {
|
|
continue
|
|
}
|
|
data[tag] = f.Value()
|
|
}
|
|
responseParsed = structs.New(response.CertificateResponse)
|
|
for _, f := range responseParsed.Fields() {
|
|
tag := utils.CleanStructFieldJSONTag(f.Tag("json"))
|
|
if tag == "" || f.IsZero() {
|
|
continue
|
|
}
|
|
data[tag] = f.Value()
|
|
}
|
|
|
|
event := eventcreator.CreateEvent(request, data, requestOptions.Options.Debug || requestOptions.Options.DebugResponse)
|
|
if requestOptions.Options.Debug || requestOptions.Options.DebugResponse || requestOptions.Options.StoreResponse {
|
|
msg := fmt.Sprintf("[%s] Dumped SSL response for %s", requestOptions.TemplateID, input.MetaInput.Input)
|
|
if requestOptions.Options.Debug || requestOptions.Options.DebugResponse {
|
|
gologger.Debug().Msg(msg)
|
|
gologger.Print().Msgf("%s", responsehighlighter.Highlight(event.OperatorsResult, jsonDataString, requestOptions.Options.NoColor, false))
|
|
}
|
|
if requestOptions.Options.StoreResponse {
|
|
request.options.Output.WriteStoreDebugData(input.MetaInput.Input, request.options.TemplateID, request.Type().String(), fmt.Sprintf("%s\n%s", msg, jsonDataString))
|
|
}
|
|
}
|
|
callback(event)
|
|
return nil
|
|
}
|
|
|
|
// RequestPartDefinitions contains a mapping of request part definitions and their
|
|
// description. Multiple definitions are separated by commas.
|
|
// Definitions not having a name (generated on runtime) are prefixed & suffixed by <>.
|
|
var RequestPartDefinitions = map[string]string{
|
|
"type": "Type is the type of request made",
|
|
"response": "JSON SSL protocol handshake details",
|
|
"not_after": "Timestamp after which the remote cert expires",
|
|
"host": "Host is the input to the template",
|
|
"matched": "Matched is the input which was matched upon",
|
|
}
|
|
|
|
// getAddress returns the address of the host to make request to
|
|
func getAddress(toTest string) (string, error) {
|
|
if strings.Contains(toTest, "://") {
|
|
parsed, err := url.Parse(toTest)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
_, port, _ := net.SplitHostPort(parsed.Host)
|
|
|
|
if strings.ToLower(parsed.Scheme) == "https" && port == "" {
|
|
toTest = net.JoinHostPort(parsed.Host, "443")
|
|
} else {
|
|
toTest = parsed.Host
|
|
}
|
|
return toTest, nil
|
|
}
|
|
return toTest, nil
|
|
}
|
|
|
|
// Match performs matching operation for a matcher on model and returns:
|
|
// true and a list of matched snippets if the matcher type is supports it
|
|
// otherwise false and an empty string slice
|
|
func (request *Request) Match(data map[string]interface{}, matcher *matchers.Matcher) (bool, []string) {
|
|
return protocols.MakeDefaultMatchFunc(data, matcher)
|
|
}
|
|
|
|
// Extract performs extracting operation for an extractor on model and returns true or false.
|
|
func (request *Request) Extract(data map[string]interface{}, matcher *extractors.Extractor) map[string]struct{} {
|
|
return protocols.MakeDefaultExtractFunc(data, matcher)
|
|
}
|
|
|
|
// MakeResultEvent creates a result event from internal wrapped event
|
|
func (request *Request) MakeResultEvent(wrapped *output.InternalWrappedEvent) []*output.ResultEvent {
|
|
return protocols.MakeDefaultResultEvent(request, wrapped)
|
|
}
|
|
|
|
// GetCompiledOperators returns a list of the compiled operators
|
|
func (request *Request) GetCompiledOperators() []*operators.Operators {
|
|
return []*operators.Operators{request.CompiledOperators}
|
|
}
|
|
|
|
// Type returns the type of the protocol request
|
|
func (request *Request) Type() templateTypes.ProtocolType {
|
|
return templateTypes.SSLProtocol
|
|
}
|
|
|
|
func (request *Request) MakeResultEventItem(wrapped *output.InternalWrappedEvent) *output.ResultEvent {
|
|
data := &output.ResultEvent{
|
|
TemplateID: types.ToString(request.options.TemplateID),
|
|
TemplatePath: types.ToString(request.options.TemplatePath),
|
|
Info: request.options.TemplateInfo,
|
|
Type: types.ToString(wrapped.InternalEvent["type"]),
|
|
Host: types.ToString(wrapped.InternalEvent["host"]),
|
|
Matched: types.ToString(wrapped.InternalEvent["host"]),
|
|
Metadata: wrapped.OperatorsResult.PayloadValues,
|
|
ExtractedResults: wrapped.OperatorsResult.OutputExtracts,
|
|
Timestamp: time.Now(),
|
|
MatcherStatus: true,
|
|
IP: types.ToString(wrapped.InternalEvent["ip"]),
|
|
}
|
|
return data
|
|
}
|