Introduction

Welcome to IPWorks Auth, a suite of secure client authorization and authentication components. The easy-to-use components allow you to embed secure user authentication into your web, desktop, and mobile applications, providing users access to protected application and service data. The library supports OAuth, NTLM, RADIUS, Kerberos, SAML, LDAP, Certificate Management, and more.

Getting Started

IPWorks Auth 2022 is delivered as a module which must first be installed prior to use. To install the module run the following command:

npm install ipworksauth-22.0.tar.gz

The module should now be installed and available for use. To use the module in your application first reference the package like so: const ipworksauth = require("@nsoftware/ipworksauth"); Instances of the classes listed below can then be created in code.

Included Classes

ActiveDirectory	The ActiveDirectory component can be used to authenticate users against Active Directory using Kerberos 5.0.
CertMgr	The CertMgr component is used to create, read, and manage certificates.
HOTP	The HOTP component allows creation of HMAC-Based One-Time passwords.
JWT	Create, Sign, Encrypt, Verify and Decrypt JSON Web Tokens (JWTs).
Kerberos	The Kerberos component can be used to authenticate users using Kerberos 5.0.
LDAP	The Lightweight Directory Access Protocol (LDAP) Component is used to search, manage, and maintain internet directory servers.
NTLM	The NTLM component provides a simple API to create the required tokens for NTLM authentication.
OAuth	The OAuth component is used to authorize a client and provide an authorization string used in future requests.
OCRA	The OCRA component implements the OATH Challenge-Response Algorithm.
OneTimePassword	The OneTimePassword component allows creation of single use passwords.
OpenID	The OpenID component is used to verify the identify of a user as well as get basic profile information.
RADIUS	The RADIUS component provides an easy way to authenticate users.
SAML	The SAML component is used to obtain security tokens and assertions.
SSHAuth	The SSHAuth component provides a simple way to authenticate a user against an SSH server.
TOTP	The TOTP component allows creation of Time-Based One-Time passwords.

Additional Information

You will always find the latest information about IPWorks Auth at our web site: www.nsoftware.com. We offer free, fully-functional 30-day trials for all of our products, and our technical support staff are happy to answer any questions you may have during your evaluation.

Please direct all technical questions to support@nsoftware.com. To help support technicians assist you as quickly as possible, please provide an detailed and accurate description of your problem, the results you expected, and the results that you received while using our product. For questions about licensing and pricing, and all other general inquiries, please contact sales@nsoftware.com.

Thank You!

Thank you for choosing IPWorks Auth for your development needs. We realize that you have a choice among development tools, and that by choosing us you are counting on us to be a key component in your business. We work around the clock to provide you with ongoing enhancements, support, and innovative products; and we will always do our best to exceed your expectations!