Passport-SAML 使用教程

项目介绍

Passport-SAML 是一个用于 Node.js 认证库 Passport 的 SAML 2.0 认证提供者。该项目最初基于 Michael Bosworth 的 express-saml 库开发，经过测试，可以与多种身份提供者（如 SimpleSAMLphp、Active Directory Federation Services、Onelogin、Okta 和 Shibboleth）配合使用。

项目快速启动

安装

首先，通过 npm 安装 Passport-SAML：

npm install @node-saml/passport-saml

配置

以下是一个简单的配置示例，使用 Feide OpenIdp 作为身份提供者：

const passport = require('passport');
const SamlStrategy = require('@node-saml/passport-saml').Strategy;

passport.use(new SamlStrategy(
  {
    path: '/login/callback',
    entryPoint: 'https://openidp.feide.no/simplesaml/saml2/idp/SSOService.php',
    issuer: 'your-issuer-id'
  },
  function(profile, done) {
    // 处理用户认证逻辑
    return done(null, profile);
  }
));

// 序列化和反序列化用户实例
passport.serializeUser(function(user, done) {
  done(null, user);
});

passport.deserializeUser(function(user, done) {
  done(null, user);
});

路由设置

在 Express 应用中设置路由：

const express = require('express');
const app = express();
const passport = require('passport');

app.use(passport.initialize());
app.use(passport.session());

app.get('/login', passport.authenticate('saml', { failureRedirect: '/', failureFlash: true }), function(req, res) {
  res.redirect('/');
});

app.post('/login/callback', passport.authenticate('saml', { failureRedirect: '/', failureFlash: true }), function(req, res) {
  res.redirect('/');
});

app.listen(3000, function() {
  console.log('App listening on port 3000!');
});

应用案例和最佳实践

应用案例

Passport-SAML 广泛应用于需要与企业级 SAML 身份提供者集成的应用中，如企业内部管理系统、云服务提供商等。

最佳实践

1. 配置安全性：确保所有配置项（如 entryPoint、issuer）都是安全的，避免泄露敏感信息。
2. 错误处理：在认证过程中，合理处理各种错误情况，如认证失败、会话超时等。
3. 缓存策略：对于多服务器/进程场景，使用外部缓存策略（如 Redis）来存储 SAML 请求 ID。

典型生态项目

Passport-SAML 作为 Passport 认证库的一部分，与其他 Passport 策略（如 OAuth、OpenID）一起构成了一个完整的认证生态系统。此外，它还可以与多种 Node.js 框架（如 Express、Koa）无缝集成，提供强大的认证支持。

通过以上步骤，您可以快速启动并使用 Passport-SAML 进行 SAML 2.0 认证。希望本教程对您有所帮助！