Skip to content

Commit

Permalink
#76 Rename from express-saml2 to samlify
Browse files Browse the repository at this point in the history
  • Loading branch information
tngan committed Jun 6, 2017
1 parent bfabc38 commit 981f88d
Show file tree
Hide file tree
Showing 18 changed files with 32 additions and 30 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ build
.idea

#vscode
.vscode
.vscode

*.tgz
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PROJECT = "express-saml2"
PROJECT = "samlify"

install: ;@echo "install ${PROJECT}"; \
yarn;
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# express-saml2 · [![Build Status](https://travis-ci.org/tngan/express-saml2.svg?branch=master)](https://travis-ci.org/tngan/express-saml2) [![npm version](https://img.shields.io/npm/v/express-saml2.svg?style=flat)](https://www.npmjs.com/package/express-saml2) [![Join the chat at https://gitter.im/tngan/express-saml2](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tngan/express-saml2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Coverage Status](https://coveralls.io/repos/github/tngan/express-saml2/badge.svg?branch=2.0.0-alpha)](https://coveralls.io/github/tngan/express-saml2?branch=2.0.0-alpha)
# samlify · [![Build Status](https://travis-ci.org/tngan/samlify.svg?branch=master)](https://travis-ci.org/tngan/samlify) [![npm version](https://img.shields.io/npm/v/samlify.svg?style=flat)](https://www.npmjs.com/package/samlify) [![Join the chat at https://gitter.im/tngan/samlify](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tngan/samlify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Coverage Status](https://coveralls.io/repos/github/tngan/samlify/badge.svg?branch=2.0.0-alpha)](https://coveralls.io/github/tngan/samlify?branch=2.0.0-alpha)

High-level Node.js API for Single Sign On (SAML 2.0)

Expand All @@ -13,7 +13,7 @@ This module provides high-level API for scalable Single Sign On (SSO) implementa
### Installation
To install the stable version
```bash
$ npm install express-saml2
$ npm install samlify
```

### Development
Expand All @@ -29,9 +29,9 @@ yarn install

### Get Started
```javascript
const saml = require('express-saml2');
const saml = require('samlify');
```
See full documentation [here](https://github.com/tngan/express-saml2/wiki)
See full documentation [here](https://github.com/tngan/samlify/wiki)

### Support algorithms
Signature algorithms
Expand Down
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
express-saml2.js.org
samlify.js.org
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## express-saml2
## samlify

> High-level API library for Single Sign On with SAML 2.0
Expand All @@ -15,13 +15,13 @@ We provide a simple interface that's highly configurable.
To install the stable version

```bash
$ npm install express-saml2
$ npm install samlify
```

or

```bash
$ yarn add express-saml2
$ yarn add samlify
```

### Use cases
Expand All @@ -40,7 +40,7 @@ Simple solution of Identity Provider is provided in this module for test and edu
!> **The constructor of entity is also modified to accept a single configuration object instead of putting metadata and advanced configurations in separate arguments.**

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
// configure a service provider
const sp = saml.ServiceProvider({
metadata: fs.readFileSync('./metadata_sp.xml')
Expand Down
6 changes: 3 additions & 3 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
![logo](_media/lock.png)

# express-saml2 <small>2.0.0 alpha</small>
# samlify <small>2.0.0</small>

> Node.js SAML2 API
- Simple and active maintenance
- Includes Identity and Service Provider
- Highly configurable

[GitHub](https://github.com/tngan/express-saml2)
[Get Started](#express-saml2)
[GitHub](https://github.com/tngan/samlify)
[Get Started](#samlify)

<!-- background image -->
![](_media/bg.jpg)
2 changes: 1 addition & 1 deletion docs/encrypted-saml-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
According to the guideline of SAML, our module leaves some security options for developers. If the assertion contains some sensitive information, Identity Provider may want to do encryption. In IdP's construction, add the following settings as follow:

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
const setting = {
isAssertionEncrypted: true,
encPrivateKeyFile: fs.readFileSync('./key/idp/encryptKey.pem'),
Expand Down
2 changes: 1 addition & 1 deletion docs/idp.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This module provides API of Identity Provider for internal test purpose. Even th

Let's get started with entry point:
```javascript
const saml = require('express-saml2');
const saml = require('samlify');
```

The following metadata is provided by the target identity provider.
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="UTF-8">
<title>express-saml2 - High-level API for Single Sign On (SAML 2.0)</title>
<title>samlify - High-level API for Single Sign On (SAML 2.0)</title>
<meta name="description" content="High-level API for Single Sign On (SAML 2.0)">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
Expand All @@ -13,8 +13,8 @@
</body>
<script>
window.$docsify = {
repo: 'tngan/express-saml2',
name: 'express-saml2',
repo: 'tngan/samlify',
name: 'samlify',
auto2top: true,
loadSidebar: true,
coverpage: true,
Expand Down
2 changes: 1 addition & 1 deletion docs/metadata-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Display the Metadata in a specific URL. Everyone has the URL can watch the Metadata. Therefore, the Metadata is distributed publicly. We provide an API to do it once you've configure your SP.

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
const sp = saml.ServiceProvider({
metadata: fs.readFileSync('./metadata_sp.xml')
});
Expand Down
2 changes: 1 addition & 1 deletion docs/onelogin.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ $ npm install
Add a file `sso.js` under `/routes` folder
```javascript
// This is /routes/sso.js
const saml = require('express-saml2');
const saml = require('samlify');
const express = require('express');
const router = express.Router();
const ServiceProvider = saml.ServiceProvider;
Expand Down
2 changes: 1 addition & 1 deletion docs/saml-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Different bindings can be used to send this request, we support Redirect-Binding
It means that the XML is embedded as an URL parameter and redirect to the SSO endpoint of IdP. Because of different length limitation in different browsers, it's required to deflate Request.

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
const sp = saml.ServiceProvider({
metadata: fs.readFileSync('./metadata_sp.xml')
});
Expand Down
2 changes: 1 addition & 1 deletion docs/signed-saml-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ If IdP doesn't provide the metadata for you, 1) you may ask them 2) import an ob
Metadata stores the preferences only. To sign a XML document, we still need our **private key** and **signature algorithm**. We can configure our SP here:

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
// Define the setting
const setting = {
privateKeyFile: fs.readFileSync('./key/sp_key.pem'),
Expand Down
2 changes: 1 addition & 1 deletion docs/sp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Let's get started to get the entry point.

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
```

You should have prepared the metadata of service provider.
Expand Down
4 changes: 2 additions & 2 deletions docs/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Developer can design their own request and response template for log-in and log-out respectively. There are optional parameters in setting object.

```javascript
const saml = require('express-saml2');
const saml = require('samlify');

// Load the template every time before each request/response is sent
const sp = saml.ServiceProvider({
Expand Down Expand Up @@ -63,7 +63,7 @@ router.get('/spinitsso-redirect', (req, res) => {
Developers may want to use our default tag replacement `saml.SamlLib.replaceTagsByValue` instead of writing their own `replaceTagFromTemplate`. It replaces all defined tags in the input XML string. This method is supported with version >= 1.1.6.

```javascript
const saml = require('express-saml2');
const saml = require('samlify');
const lib = saml.SamlLib;
const requestTags = saml.Constants.tags.request;
// ...
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "express-saml2",
"version": "2.0.0-beta",
"name": "samlify",
"version": "2.0.0-rc.1",
"description": "High-level API for Single Sign On (SAML 2.0)",
"main": "build/index.js",
"keywords": [
Expand All @@ -25,7 +25,7 @@
],
"author": "tngan",
"repository": {
"url": "https://github.com/tngan/express-saml2",
"url": "https://github.com/tngan/samlify",
"type": "git"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion src/urn.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file urn.ts
* @author tngan
* @desc Includes all keywords need in express-saml2
* @desc Includes all keywords need in samlify
*/
const namespace = {
binding: {
Expand Down
Binary file removed tslint-5.4.3.tgz
Binary file not shown.

0 comments on commit 981f88d

Please sign in to comment.