Imperial
A Vapor middleware for adding federated authentication with OAuth providers to Swift server applications.
What is Imperial?
Imperial is a Swift package that provides federated authentication with OAuth providers for Vapor applications. It simplifies integrating external login services like GitHub by handling the OAuth flow, token storage, and route protection, allowing developers to offload user authentication to trusted third-party providers.
Swift developers building server-side applications with the Vapor framework who need to implement secure, federated user authentication without managing user credentials directly.
Developers choose Imperial because it offers a Vapor-native, middleware-based solution that reduces the boilerplate and complexity of implementing OAuth, with built-in session management and route protection tailored for Swift server environments.
Overview
Federated Authentication with OAuth providers
Use Cases
Best For
- Adding GitHub login to a Vapor web application
- Protecting API routes in a Vapor server with OAuth-based authentication
- Implementing federated authentication for a Swift backend service
- Simplifying OAuth integration in Vapor projects with pre-built provider support
- Managing user sessions and access tokens from external identity providers in Swift
Not Ideal For
- Applications built with other server frameworks like Express.js or Django, as it is Vapor-specific.
- Projects requiring stateless JWT authentication without server-side sessions, due to its reliance on Vapor's session middleware.
- Teams needing built-in user profile management or database integration, as it focuses solely on OAuth flow and token handling.
- Mobile or client-side apps where OAuth should be handled client-side, since it's designed for server-side Vapor backends.
Pros & Cons
Pros
Tailored for Vapor's ecosystem, using its sessions middleware and routing system, as shown in the README's configuration examples for easy setup.
Includes modules like ImperialGitHub for quick integration with external services, reducing boilerplate code for OAuth implementation.
Offers ImperialMiddleware to guard routes with minimal code, ensuring only authenticated users access protected endpoints, as demonstrated in the grouped routes example.
Allows custom logic or simple redirects in OAuth callbacks, giving developers control over post-authentication flows, as highlighted in the route registration options.
Cons
Exclusively tied to the Vapor framework, making it incompatible with other Swift server environments or non-Swift projects, limiting its portability.
Relies on Vapor's sessions for token storage, which may not suit stateless APIs or applications preferring JWT or other token-based approaches without server sessions.
As a vapor-community project, it might have slower updates or less official support compared to core Vapor packages, potentially affecting long-term reliability.
Frequently Asked Questions
Related Projects
MongoKittenNative MongoDB driver for Swift, written in Swift
SwifQL💎 A Swift DSL for type-safe, extensible, and transformable SQL queries.
Stripe ProviderStripe library for Vapor
Vapor Security HeadersHarden Your Security Headers For Vapor
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.