Welcome to the SCION project documentation!

If you would like to contribute to SCION project, the Contributing to the SCION code base is a good place to start.

Developer docs:

• Contributing to the SCION code base
  • What skills do you need to contribute?
  • Finding an issue to contribute to
  • Learning resources
  • Language style guides
• Setting up the development environment
  • Bazel & Co.
  • Alternative: go build
  • Running SCION locally
  • Wireshark
• Managing external dependencies
  • Go
• Testing
  • Cryptography Testing
  • Hidden Paths testing
  • Go mocks
  • Golden Files

Design docs:

• SCION Cryptography
• SCION Protocols
• Path Policy Language Design
• Hidden Paths
• Path Metadata in Beacons

Proposals:

• SCION Address URI encoding
• Teaching gRPC some path-awareness
• EPIC Design
• COLIBRI Service Design
• Beacon Service Design
• Path Service
• Automated end host bootstrapping

Operational manuals:

• Common settings
  • HTTP API
• Router
  • Port table
  • Metrics
  • HTTP API
• Dispatcher
  • Port table
  • HTTP API
• Daemon
  • Port table
  • HTTP API
• Control Service
  • Port table
  • Metrics
  • HTTP API
• Gateway
  • Nomenclature
  • Port table
  • Metrics
  • HTTP API
  • Routing Policy File
  • Network prefix pinning

CLI tools:

• scion
  • Synopsis
  • Options
  • SEE ALSO
• scion-pki
  • Synopsis
  • Options
  • SEE ALSO

Indices and tables

• Index
• Module Index
• Search Page