Version Control Plan: Currently we have two branches: dev branch and master branch. Our plan is to create 4 branches off of the dev branch for each team member, to ensure that we can each make commits without disrupting each other's work. Everyone will be working on separate project components so that we don't create rebasing issues. There is a rule in place that won't allow any members make a merge to a branch without another member reviewing the code first. Every member is responsible for fixing any rebasing issues they create. This helps to prevent merge conflicts.
All members are required to use concise but descriptive commit messages. Each message should clearly describe the changes that were made, as fits within the character count.
This project was bootstrapped with Create React App.
In the project directory, you can run:
You will need to run
npm install nodemon -g
nodemon will run the node app and when it detects a change in the file, it will restart the server. No more ctrl+c and npm start manually!
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
services: active-directory platforms: nodejs author: brandwe
This Node.js server will give you a quick and easy way to set up a REST API Service using the OAuth2 protocol. Then this service is integrated with Azure Active Directory for API protection. The sample server included in the download is designed to run on any platform.
This REST API server is built using Restify and MongoDB with the following features:
- A node.js server running an REST API interface with JSON using MongoDB as persistent storage
- REST APIs leveraging OAuth2 API protection for endpoints using Azure Active Directory
We've released all of the source code for this example in GitHub under an Apache 2.0 license, so feel free to clone (or even better, fork!) and provide feedback on the forums.
[!Note] If you want to run this sample on Azure Government, navigate to the "Azure Government Deviations" section at the bottom of this page.
Getting started with the sample is easy. It is configured to run out of the box with minimal setup.
To use this sample you will need a Azure Active Directory Tenant. If you're not sure what a tenant is or how you would get one, read What is an Azure AD tenant? or Sign up for Azure as an organization. These docs should get you started on your way to using Azure AD.
After you get your Azure AD tenant, add this sample app to your tenant so you can use it to protect your API endpoints. If you need help with this step, see: Register the REST API Service Azure Active Directory
To successfully use this sample, you need a working installation of Node.js.
Install Node.js from http://nodejs.org.
To successfully use this sample, you must have a working installation of MongoDB. We will use MongoDB to make our REST API persistent across server instances.
Install MongoDB from http://mongodb.org.
NOTE: This walkthrough assumes that you use the default installation and server endpoints for MongoDB, which at the time of this writing is: mongodb://localhost. This should work locally without any configuration changes if you run this sample on the same machine as you've installed and ran mongodb.
Next, clone the sample repo and install the NPM.
From your shell or command line:
$ git clone https://github.com/Azure-Samples/active-directory-node-webapi.git$ cd node-server$ npm install
You will need to update the sample to use your values for the metadata endpoint.
NOTE: If you wish to accept multiple tenants for this app, you'll want to use the common endpoint and you'll need to pass the issuer: and audience: value if you wish to validate that as well.
$ cd node-server$ node app.js
Is the server output hard to understand?: We use bunyan for logging in this sample. The console won't make much sense to you unless you also install bunyan and run the server like above but pipe it through the bunyan binary:
$ npm install -g bunyan$ node app.js | bunyan
You will have a server successfully running on http://localhost:3000. Your REST / JSON API Endpoint will be http://localhost:3000/tasks
| Library | Docs | Support | Protocol |
|---|
This sample demonstrates how to set up OpenId Connect authentication in a web application built using Node.js with Express. The sample is designed to run on any platform.
To run this sample you will need the following:
-
Install Node.js from http://nodejs.org/
-
An Azure AD tenant. If you're not sure what a tenant is or how you would get one, read How to get an Azure AD tenant.
-
Sign in to the Azure portal.
-
On the top bar, click on your account, and then on Switch Directory. Once the Directory + subscription pane opens, choose the Active Directory tenant where you wish to register your application.
-
Click on All services in the left-hand nav, and choose Azure Active Directory.
-
Click on App registrations and choose New application registration.
-
Enter a friendly name for the application, for example 'Webapp-Openidconnect' and select 'Web app / API' as the Application Type.
-
For the sign-on URL, enter the base URL for this sample which is
http://localhost:3000/. -
Click Create to create the application.
-
In the succeeding page, Find the Application ID value and record it for later. You'll need it to configure the client ID in the application.
-
Under Settings, choose Properties and update the App ID URI which is a unique identifier for your app. It is of the format 'https://<your_tenant_name>/<app_name>' replacing
<your_tenant_name>with the name of your Azure AD tenant. For example:https://contoso.onmicrosoft.com/Webapp-Openidconnect -
Under Settings, click on Reply URLs and set it to
http://localhost:3000/auth/openid/returnwhich this sample uses by default. -
From the Settings menu, choose Keys and add a new entry in the Password section:
- Type a key description (for instance 'app secret'),
- Select a key duration of either In 1 year, In 2 years, or Never Expires.
- When you save this page, the key value will be displayed. Copy, and save the value in a safe location.
- You'll need this key later to configure the client secret in the app. This key value will not be displayed again, nor retrievable by any other means, so record it as soon as it is visible from the Azure portal.
Next, clone the sample repo and install the NPM modules.
From your shell or command line run:
$ git clone [email protected]:AzureADQuickStarts/WebApp-OpenIDConnect-NodeJS.git
or
$ git clone https://github.com/AzureADQuickStarts/WebApp-OpenIDConnect-NodeJS.git
From the project root directory, run the command:
$ npm install
Provide the parameters in exports.creds in config.js as instructed.
- Update
<tenant_name>inexports.identityMetadatawith the Azure AD tenant name of the format *.onmicrosoft.com. - Update
exports.clientIDwith the Application Id noted from app registration. - Update
exports.clientSecretwith the Application key noted from app registration. - Update
exports.redirectUrlwith the Reply URL noted from app registration.
Optional configuration for production apps:
-
Update
exports.destroySessionUrlin config.js, if you want to use a differentpost_logout_redirect_uri. -
Set
exports.useMongoDBSessionStorein config.js to true, if you want to use use mongoDB or other compatible session stores. The default session store in this sample isexpress-session. Note that the default session store is not suitable for production. -
Update
exports.databaseUri, if you want to use mongoDB session store and a different database URI. -
Update
exports.mongoDBSessionMaxAge. Here you can specify how long you want to keep a session in mongoDB. The unit is second(s).
-
Start mongoDB service. If you are using mongoDB session store in this app, you have to install mongoDB and start the service first. If you are using the default session store, you can skip this step.
-
Run the app using the following command from your command line.
$ node app.js
Is the server output hard to understand?: We use bunyan for logging in this sample. The console won't make much sense to you unless you also install bunyan and run the server like above but pipe it through the bunyan binary:
$ npm install -g bunyan
$ node app.js | bunyan
You will have a server successfully running on http://localhost:3000.
We use Stack Overflow with the community to provide support. We highly recommend you ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before. Make sure that your questions or comments are tagged with [azure-active-directory].
If you find a bug or issue with this sample, please raise the issue on GitHub Issues.
For issues with the passport-azure-ad library, please raise the issue on the library GitHub repo.
If you'd like to contribute to this sample, please follow the GitHub Fork and Pull request model.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
This library controls how users sign-in and access services. We recommend you always take the latest version of our library in your app when possible.
If you find a security issue with our libraries or services please report it to [email protected] with as much detail as possible. Your submission may be eligible for a bounty through the Microsoft Bounty program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting this page and subscribing to Security Advisory Alerts.
We would like to acknowledge the folks who own/contribute to the following projects for their support of Azure Active Directory and their libraries that were used to build this sample. In places where we forked these libraries to add additional functionality, we ensured that the chain of forking remains intact so you can navigate back to the original package. Working with such great partners in the open source community clearly illustrates what open collaboration can accomplish. Thank you!
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License (the "License");