# node-sp-auth-config > Config options builder for node-sp-auth (SharePoint Authentication in Node.js) Latest version **3.0.5** (published 2022-08-19) · MIT license · 0 weekly downloads ## Install ```sh npm install node-sp-auth-config pnpm add node-sp-auth-config yarn add node-sp-auth-config bun add node-sp-auth-config ``` Provides the command `sp-auth`. ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 3.0.5 | | Published | 2022-08-19 | | First published | 2017-05-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 140.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 21 | | Author | Andrew Koltyakov | | Maintainers | s-kainet, koltyakov | | Keywords | sharepoint, config, authentication, node-sp-auth, wizard | ## Links - npm: https://www.npmjs.com/package/node-sp-auth-config - Repository: https://github.com/koltyakov/node-sp-auth-config - Homepage: https://github.com/koltyakov/node-sp-auth-config#readme - Issues: https://github.com/koltyakov/node-sp-auth-config/issues - npm.io page: https://npm.io/package/node-sp-auth-config ## Dependencies (6) - [cpass](https://npm.io/package/cpass.md) ^2.3.0 - [colors](https://npm.io/package/colors.md) ^1.4.0 - [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4 - [inquirer](https://npm.io/package/inquirer.md) ^8.2.4 - [commander](https://npm.io/package/commander.md) ^9.4.0 - [node-sp-auth](https://npm.io/package/node-sp-auth.md) ^3.0.7 ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 3.0.5 (latest) — 2022-08-19 - 3.0.0-beta.0 (beta) — 2020-06-13 - 3.0.4 — 2022-08-15 - 3.0.3 — 2022-08-15 - 3.0.2 — 2022-01-10 - 3.0.1 — 2020-06-29 - 3.0.0 — 2020-06-21 - 2.9.4 — 2020-05-12 - 2.9.3 — 2020-03-24 - 2.9.2 — 2019-11-20 - 2.9.1 — 2019-11-13 - 2.9.0-beta.0 — 2019-11-04 - 2.8.0 — 2019-10-04 - 2.7.0 — 2019-09-14 - 2.6.7 — 2019-06-22 - … 52 more at https://npm.io/package/node-sp-auth-config/versions ## README # node-sp-auth-config - Config options builder for node-sp-auth (SharePoint Authentication in Node.js) [![NPM](https://nodei.co/npm/node-sp-auth-config.png?mini=true&downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/node-sp-auth-config/) [![npm version](https://badge.fury.io/js/node-sp-auth-config.svg)](https://badge.fury.io/js/node-sp-auth-config) [![Downloads](https://img.shields.io/npm/dm/node-sp-auth-config.svg)](https://www.npmjs.com/package/node-sp-auth-config) [![Actions Status](https://github.com/koltyakov/node-sp-auth-config/workflows/Node%20CI/badge.svg)](https://github.com/koltyakov/node-sp-auth-config/actions) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkoltyakov%2Fnode-sp-auth-config.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkoltyakov%2Fnode-sp-auth-config?ref=badge_shield) [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/sharepoint-node/Lobby) `node-sp-auth-config` provides wizard-like approach for building and managing config files for [node-sp-auth](https://github.com/s-KaiNet/node-sp-auth) (Node.js to SharePoint unattended http authentication). Includes CLI for generating config files from a command prompt. **Versions supported**: - SharePoint Online - SharePoint 2019 - SharePoint 2016 - SharePoint 2013 - SharePoint 2010 **Authentication options**: - SharePoint Online: - User credentials (SAML/ADFS) - Add-In Only permissions - On-Demand authentication (using Electron popup) - SharePoint 2019, 2016, 2013: - User credentials (NTLM, NTLM v2) - ADFS user credentials - Form-based authentication (FBA) - Form-based authentication (Forefront TMG) - Add-In Only permissions - On-Demand authentication (using Electron popup) - SharePoint 2010: - User credentials (NTLM, NTMLv2) - Form-based authentication (FBA) - Form-based authentication (Forefront TMG) Config layer and auth support Office 365 Dedicated (SPO on a custom domain) as well. --- ## How to use ### Install ```bash npm install node-sp-auth-config --save ``` or install globally to use as CLI: ```bash npm install node-sp-auth-config -g ``` ### Usage as CLI ```bash sp-auth init --path ./config/private.config.json sp-auth --help # for help about parameters ``` ### Usage in TypeScript ```javascript import { AuthConfig } from 'node-sp-auth-config'; const authConfig = new AuthConfig({ configPath: './config/private.json', encryptPassword: true, saveConfigOnDisk: true }); authConfig.getContext() .then((context) => { console.log(JSON.stringify(context, null, 2)); // context.authOptions - node-sp-auth authentication options }) .catch(console.warn); ``` ### Usage in JavaScript ```javascript const AuthConfig = require('node-sp-auth-config').AuthConfig; const authConfig = new AuthConfig({ configPath: './config/private.json', encryptPassword: true, saveConfigOnDisk: true }); authConfig.getContext() .then((context) => { console.log(JSON.stringify(context, null, 2)); // context.authOptions - node-sp-auth authentication options }) .catch(console.warn); ``` #### Initiation parameters | Parameter | Default value | Description | | --- | --- | --- | | configPath | '`./config/private.json`' | Path to auth config `.json` | | encryptPassword | `true` | Encrypt password to a machine-bind hash | | saveConfigOnDisk | `true` | Save config `.json` to disk | | forcePrompts | `false` | Force parameters prompts | | headlessMode | `false` | Prevents interactive prompts - for headless, CI/CD processes | | defaultConfigPath | empty | Path to `.json` config, parameters from which are placed as defaults | | authOptions | empty | Any valid `node-sp-auth` options | ### Production runtime #### Headless mode When using in a headless mode, in case of missing parameters, one can expect non-interactive behavior with no prompts but graceful exit with corresponding error output. This can be achieved by providing `headlessMode` settings property is equal to `true`. The headless mode also automatically configured when `NODE_ENV` (or `SPAUTH_ENV`) environment variable is equal to `production`. #### Environment variables All the parameters which are usually stored in `private.json` can be defined also using environment variables. Environment variables started with `SPAUTH_` prefix are recognized with the library. The second part of the name is an actual name of the `node-sp-auth` credentials property yet in uppercase (e.g. `SPAUTH_SITEURL`, `SPAUTH_USERNAME`, `SPAUTH_PASSWORD`). Along with credentials props these service variables are used: | Variable | Description | | --- | --- | | `NODE_ENV` | When equal to `production` forces `headlessMode`. | | `SPAUTH_ENV` | When equal to `production` forces `headlessMode`. Overwrites `NODE_ENV`. | | `SPAUTH_FORCE` | Makes `SPAUTH_{CREDENTIALS}` variables take precedence over those possibly stored in `private.json`. | ## Configuring CI/CD Checkout [this end-to-end sample](https://github.com/koltyakov/sppp-cicd-sample). ## License [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkoltyakov%2Fnode-sp-auth-config.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkoltyakov%2Fnode-sp-auth-config?ref=badge_large) --- _Source: https://npm.io/package/node-sp-auth-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._