How litesaml/lightsaml works
Project type and purpose
• This is an open-source PHP library (“Lite Saml”) implementing core SAML 2.0 functionality: data models, XML serialization/deserialization, XML-security (sign/verify), HTTP bindings, message building, validation, and a pluggable execution pipeline. It’s meant to be embedded in Service Providers or Identity Providers, not a standalone web app.
Main components
a. Binding Layer
• HttpRedirectBinding, HttpPostBinding, SamlPostResponse
• Responsibilities: map HTTP requests/responses ↔ SAML XML payloads
b. Data Model Layer
• Model classes under src/Model (Assertion, Protocol, Metadata, XmlDSig)
• Holds the in-memory representation of SAML messages
c. Serialization / Deserialization
• XmlDSig readers/writers, serialization contexts → XML↔PHP objects
d. Action Pipeline Engine
• ActionInterface, CompositeAction, ActionLogWrapper, DispatchEventAction
• Chain-of-Responsibility for validating, transforming, dispatching messages
e. Profile Builders & Contexts
• Builder/* (ActionBuilder, ProfileBuilder, ContextBuilders)
• ProfileContext, AssertionContext, EndpointContext
• High-level entry points for SP/IdP use cases (SSO, SLO)
f. Credentials, Providers, Resolvers, Store Modules
• CredentialInterface, X509Credential; Providers fetch keys/metadata;
Resolver implementations pick the right credential/endpoint;
Store interfaces for persistence of metadata, state, trust options, request states
g. DI Container Bridge
• Bridge/Pimple Container classes, Factory providers → sets up all services via Pimple
h. Error & Event System
• LightSaml*Exception classes, Event classes (MessageReceived, MessageSent)
Component relationships & data flow
• Incoming HTTP Request → Binding Layer (HttpPost/Redirect)
• Binding outputs raw XML → Deserialization Context → Data Model objects
• Model enters Action Pipeline
• each Action (signature, issuer, time, replay-attack checks)
• Actions may call Providers/Resolvers/Stores
• On success, DispatchEventAction emits MessageReceived
• Consumer code uses Profile Context or Builder to produce outbound message
• Builder composes Action pipeline for outbound, calls SignMessageAction, SaveRequestStateAction, etc.
• Pipeline ends in SendMessageAction → Binding → HTTP Response/Redirect
Architectural patterns & design principles
• Chain of Responsibility: Action pipeline (ActionInterface, CompositeAction)
• Builder & Factory: ProfileBuilder, ActionBuilder, CredentialResolverFactory
• Strategy/Resolver: pluggable CredentialResolver, EndpointResolver
• Dependency Injection: Pimple bridge for wiring modules
• Composite: CompositeAction, CompositeResolver, CompositeTrustOptionsStore
Technologies & frameworks
• PHP 8.1, Composer autoload
• Pimple for DI
• PHPUnit for tests
• phpstan, phpcs, rector for static analysis & code style
Final checklist
• Clear component labels and namespaces
• External integration points (HTTP layer, user code that invokes ProfileBuilder)