How snyk/broker works
Main Components
a. External Systems:
• Snyk.io (Cloud Service)
• Git Providers (GitHub Enterprise, GitHub.com, Bitbucket Server)
• Jira (On-premise)
• Container Registries
b. Core Components:
• Broker Server
• Broker Client
• Applicative Tunnel
• Authentication/Authorization Layer
• Filter Rules Engine
• WebSocket Connection Manager
• HTTP/HTTPS Request Handler
Architecture Pattern
[External Zone (Snyk.io)] <---> [Broker Server] <---> [Secure Tunnel] <---> [Broker Client] <---> [Internal Zone (Git/Jira)]
Key Relationships to Highlight
a. Communication Flows:
• Bidirectional secure tunnel between Broker Server and Client
• Filtered requests from Snyk.io to internal systems
• Webhook events from internal systems to Snyk.io
• Authentication flows for different providers
b. Security Layers:
• Filter rules and validation
• Token-based authentication
• Request/Response scanning
• Connection pooling
Component Details
Client Side (Internal Network):
• Client configuration system (/lib/client)
• Connection management (/lib/client/connectionsManager)
• Filtering system (/lib/common/filter)
• Plugin architecture (/lib/client/brokerClientPlugins)
Server Side:
• Dispatcher system (/lib/server/infra)
• Route handlers (/lib/server/routesHandlers)
• Socket management (/lib/server/socket)
Additional Elements
Specialized components for:
• Health checking system
• Metrics collection
• Plugin system
• Certificate management
• PGP signing capabilities
Implementation Details to Note
• WebSocket-based communication
• HTTP/HTTPS proxying
• Filter rule application
• Authentication mechanisms
• Plugin extensibility
[External Services Layer]
• ↕
[Security/Authentication Layer]
• ↕
[Broker Server Layer]
• ↕
[Secure Tunnel Layer]
• ↕
[Broker Client Layer]
• ↕
[Internal Services Layer]