Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions integration_tests/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,19 @@ services:
- mongodb-4.1.2-network
hostname: "target"

mongodb-4.0.1-tls:
build:
context: ./mongodb/container
container_name: "zgrab_mongodb-4.0.1-tls"
networks:
- mongodb-4.0.1-tls-network
hostname: "target"
healthcheck:
test: ["CMD", "mongo", "--ssl", "--sslAllowInvalidCertificates", "--quiet", "--eval", "assert.commandWorked(db.adminCommand({ping: 1}))"]
interval: 2s
timeout: 5s
retries: 30

mongodb-8.0:
image: "mongo:8.0"
container_name: "zgrab_mongodb-8.0"
Expand Down Expand Up @@ -618,6 +631,11 @@ networks:
ipam:
config:
- subnet: 100.64.0.56/30
mongodb-4.0.1-tls-network:
driver: bridge
ipam:
config:
- subnet: 100.64.0.200/30
mqtt-network:
driver: bridge
ipam:
Expand Down
12 changes: 12 additions & 0 deletions integration_tests/mongodb/container/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM mongo:4.0.1

RUN openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 \
-keyout /tmp/mongodb.key \
-out /tmp/mongodb.crt \
-subj "/CN=target" && \
cat /tmp/mongodb.key /tmp/mongodb.crt > /etc/ssl/mongodb.pem && \
chown mongodb:mongodb /etc/ssl/mongodb.pem && \
chmod 600 /etc/ssl/mongodb.pem && \
rm /tmp/mongodb.key /tmp/mongodb.crt

CMD ["mongod", "--bind_ip_all", "--sslMode", "requireSSL", "--sslPEMKeyFile", "/etc/ssl/mongodb.pem", "--sslAllowConnectionsWithoutCertificates"]
43 changes: 43 additions & 0 deletions integration_tests/mongodb/test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,46 @@ for version in $versions; do
echo ")}] END docker logs from $CONTAINER_NAME"
done

CONTAINER_NAME=zgrab_mongodb-4.0.1-tls
echo "mongodb/test: Testing $CONTAINER_NAME"
CONTAINER_NAME=$CONTAINER_NAME "$ZGRAB_ROOT/docker-runner/docker-run.sh" mongodb --tls > "$ZGRAB_OUTPUT/mongodb/4.0.1-tls.json"

CONTAINER_NAME=$CONTAINER_NAME "$ZGRAB_ROOT/docker-runner/docker-run.sh" mongodb --tls --allow-tls-downgrade > "$ZGRAB_OUTPUT/mongodb/4.0.1-tls-downgrade-tls.json"
CONTAINER_NAME=zgrab_mongodb-4.0.1 "$ZGRAB_ROOT/docker-runner/docker-run.sh" mongodb --tls --allow-tls-downgrade > "$ZGRAB_OUTPUT/mongodb/4.0.1-tls-downgrade-plaintext.json"

python3 - "$ZGRAB_OUTPUT/mongodb/4.0.1-tls.json" \
"$ZGRAB_OUTPUT/mongodb/4.0.1-tls-downgrade-tls.json" \
"$ZGRAB_OUTPUT/mongodb/4.0.1-tls-downgrade-plaintext.json" <<'PY'
import json
import sys

for filename in sys.argv[1:]:
with open(filename) as output:
scan = json.load(output)["data"]["mongodb"]

if scan["status"] != "success":
sys.exit(f"mongodb/test: Scan failed in {filename}: {scan}")

result = scan["result"]
if result["build_info"]["version"] != "4.0.1":
sys.exit(f"mongodb/test: Unexpected server version in {filename}: {result['build_info']}")
if result["is_master"]["is_master"] is not True:
sys.exit(f"mongodb/test: Unexpected isMaster response in {filename}: {result['is_master']}")
if not result["database_info"]["databases"]:
sys.exit(f"mongodb/test: No databases returned in {filename}: {result['database_info']}")

if filename.endswith("-plaintext.json"):
if "tls" in result:
sys.exit(f"mongodb/test: Unexpected TLS log after plaintext fallback in {filename}")
else:
tls = result.get("tls", {})
if tls.get("handshake_completed_successfully") is not True:
sys.exit(f"mongodb/test: No successful TLS handshake logged in {filename}")
handshake = tls.get("handshake_log", {})
if not handshake.get("server_hello") or not handshake.get("server_certificates"):
sys.exit(f"mongodb/test: Missing TLS server hello or certificates in {filename}")
PY

echo "mongodb/test: BEGIN docker logs from $CONTAINER_NAME [{("
docker logs --tail all "$CONTAINER_NAME"
echo ")}] END docker logs from $CONTAINER_NAME"
34 changes: 31 additions & 3 deletions modules/mongodb/scanner.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"encoding/hex"
"errors"
"fmt"
"net"

log "github.com/sirupsen/logrus"
"gopkg.in/mgo.v2/bson"
Expand All @@ -19,7 +20,17 @@ func NewModule() *zgrab2.TypedModule[Flags, Scanner, *Scanner] {

// Flags contains mongodb-specific command-line flags.
type Flags struct {
zgrab2.BaseFlags `group:"Basic Options"`
zgrab2.BaseFlags `group:"Basic Options"`
zgrab2.TLSFlags `group:"TLS Options"`
UseTLS bool `long:"tls" description:"Sends probe with TLS connection. Loads TLS module command options."`
AllowTLSDowngrade bool `long:"allow-tls-downgrade" description:"If --tls is enabled and the TLS handshake fails, fall back to plaintext instead of aborting. Requires --tls."`
}

func (f Flags) Validate(_ []string) error {
if f.AllowTLSDowngrade && !f.UseTLS {
return errors.New("--allow-tls-downgrade requires --tls")
}
return nil
}

// Scanner implements the zgrab2.Scanner interface
Expand All @@ -44,6 +55,9 @@ type scan struct {
// Close cleans up the scanner.
func (scan *scan) Close() {
defer scan.close()
if tlsConn, ok := scan.conn.conn.(*zgrab2.TLSConnection); ok {
scan.result.TLSLog = tlsConn.GetLog()
}
}

// getIsMasterMsg returns a mongodb message containing isMaster command.
Expand Down Expand Up @@ -122,7 +136,7 @@ func getOpMsg(section []byte) []byte {
// getBuildInfoOpMsg returns a mongodb "OP" message containing query to retrieve MongoDB build info.
func getBuildInfoOpMsg() []byte {
// gleaned from tshark
section_payload, err := bson.Marshal(bson.M{"buildinfo": 1, "$db": "admin"})
section_payload, err := bson.Marshal(bson.D{{Name: "buildinfo", Value: 1}, {Name: "$db", Value: "admin"}})
if err != nil {
// programmer error
log.Fatalf("Invalid BSON: %v", err)
Expand Down Expand Up @@ -190,6 +204,7 @@ type Result struct {
IsMaster *IsMaster_t `json:"is_master,omitempty"`
BuildInfo *BuildInfo_t `json:"build_info,omitempty"`
DatabaseInfo *ListDatabases_t `json:"database_info,omitempty"`
TLSLog *zgrab2.TLSLog `json:"tls,omitempty"`
}

// Init initializes the scanner
Expand All @@ -203,14 +218,27 @@ func (scanner *Scanner) Init(flags zgrab2.ScanFlags) error {
scanner.listDatabasesMsg = getListDatabasesMsg()
scanner.DialerGroupConfig = &zgrab2.DialerGroupConfig{
TransportAgnosticDialerProtocol: zgrab2.TransportTCP,
TLSEnabled: f.UseTLS,
BaseFlags: &f.BaseFlags,
NeedSeparateL4Dialer: f.AllowTLSDowngrade,
}
if f.UseTLS {
scanner.DialerGroupConfig.TLSFlags = &f.TLSFlags
}
return nil
}

// StartScan opens a connection to the target and sets up a scan instance for it.
func (scanner *Scanner) StartScan(ctx context.Context, target *zgrab2.ScanTarget, dialGroup *zgrab2.DialerGroup) (*scan, error) {
conn, err := dialGroup.Dial(ctx, target)
var (
conn net.Conn
err error
)
if scanner.config.AllowTLSDowngrade {
conn, _, err = dialGroup.DialTLSDowngrade(ctx, target, true)
} else {
conn, err = dialGroup.Dial(ctx, target)
}
if err != nil {
return nil, fmt.Errorf("failed to dial %s: %w", target.String(), err)
}
Expand Down
24 changes: 24 additions & 0 deletions modules/mongodb/scanner_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package mongodb

import "testing"

func TestFlagsValidate(t *testing.T) {
tests := []struct {
name string
flags Flags
wantErr bool
}{
{name: "plaintext"},
{name: "TLS", flags: Flags{UseTLS: true}},
{name: "TLS with downgrade", flags: Flags{UseTLS: true, AllowTLSDowngrade: true}},
{name: "downgrade without TLS", flags: Flags{AllowTLSDowngrade: true}, wantErr: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := tt.flags.Validate(nil)
if (err != nil) != tt.wantErr {
t.Fatalf("Validate() error = %v, wantErr %v", err, tt.wantErr)
}
})
}
}
1 change: 1 addition & 0 deletions zgrab2_schemas/zgrab2/mongodb.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
{
"result": SubRecord(
{
"tls": zgrab2.tls_log,
"build_info": SubRecord(
{
"version": String(doc="Version of mongodb server"),
Expand Down
Loading