├── .gitignore
├── package.json
├── .github
    ├── ISSUE_TEMPLATE
    │   ├── -anything-else.md
    │   └── --bug_report.md
    └── PULL_REQUEST_TEMPLATE.md
├── README.md
├── lib
    └── index.js
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name"         : "node-red-auth-github",
 3 |     "version"      : "0.1.1",
 4 |     "description"  : "A GitHub authentication plugin for Node-RED",
 5 |     "homepage"     : "http://nodered.org",
 6 |     "license"      : "Apache-2.0",
 7 |     "repository"   : {
 8 |         "type":"git",
 9 |         "url":"https://github.com/node-red/node-red-auth-twitter.git"
10 |     },
11 |     "main": "./lib/index.js",
12 |     "author": [
13 |         {"name": "Nick O'Leary", "email": "nick.oleary@gmail.com"}
14 |     ],
15 |     "keywords": [
16 |         "node-red",
17 |         "github",
18 |         "node-red-auth",
19 |         "authentication",
20 |         "auth"
21 |     ],
22 |     "dependencies": {
23 |         "passport-github": "1.1.0"
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/-anything-else.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Anything Else
 3 | about: Something that is not a bug report
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | Please DO NOT raise an issue.
11 | 
12 | We DO NOT use the issue tracker for general support or feature requests. Only bug reports should be raised here using the 'Bug report' template.
13 | 
14 | For general support, please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack). You could also consider asking a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/node-red) and tag it `node-red`. 
15 | That way the whole Node-RED user community can help, rather than rely on the core development team.
16 | 
17 | For feature requests, please use the Node-RED Forum](https://discourse.nodered.org). Many ideas have already been discussed there and you should search that for your request before starting a new discussion.
18 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | <!--
 2 | ## Before you hit that Submit button....
 3 | 
 4 | Please read our [contribution guidelines](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md)
 5 | before submitting a pull-request.
 6 | 
 7 | ## Types of changes
 8 | 
 9 | What types of changes does your code introduce?
10 | Put an `x` in the boxes that apply
11 | -->
12 | 
13 | - [ ] Bugfix (non-breaking change which fixes an issue)
14 | - [ ] New feature (non-breaking change which adds functionality)
15 | 
16 | <!--
17 | If you want to raise a pull-request with a new feature, or a refactoring
18 | of existing code, it **may well get rejected** if it hasn't been discussed on
19 | the [forum](https://discourse.nodered.org) or
20 | [slack team](https://nodered.org/slack) first.
21 | 
22 | -->
23 | 
24 | ## Proposed changes
25 | 
26 | <!-- Describe the nature of this change. What problem does it address? -->
27 | 
28 | ## Checklist
29 | <!-- Put an `x` in the boxes that apply -->
30 | 
31 | - [ ] I have read the [contribution guidelines](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md)
32 | - [ ] For non-bugfix PRs, I have discussed this change on the forum/slack team.
33 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/--bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Reproducible software issues
 4 | title: ''
 5 | labels: ''
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | <!--
11 | This issue tracker is for problems with the Node-RED GitHub Auth Plugin.
12 | 
13 | If your issue is:
14 |   - a general 'how-to' type question,
15 |   - a feature request or suggestion for a change,
16 |   - or problems with 3rd party (`node-red-contrib-`) nodes
17 | 
18 | please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack).
19 | 
20 | You could also consider asking a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/node-red) and tag it `node-red`.
21 | 
22 | That way the whole Node-RED user community can help, rather than rely on the core development team.
23 | 
24 | To help us understand the issue, please fill-in as much of the following information as you can:
25 | -->
26 | 
27 | ### What are the steps to reproduce?
28 | 
29 | ### What happens?
30 | 
31 | ### What do you expect to happen?
32 | 
33 | ### Please tell us about your environment:
34 | 
35 | - [ ] node-red-auth-github version:
36 | - [ ] Node-RED version:
37 | - [ ] Node.js version:
38 | - [ ] npm version:
39 | - [ ] Platform/OS:
40 | - [ ] Browser:
41 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Node-RED Authentication with GitHub
 2 | 
 3 | [Node-RED](https://nodered.org) plugin for authenticating users with GitHub.
 4 | 
 5 | This modules lets you restrict access to the Node-RED editor to specific GitHub
 6 | users.
 7 | 
 8 | **Note:** this requires Node-RED 0.17 or later
 9 | 
10 | 
11 | ## Install
12 | 
13 | In your Node-RED user directory, typically `~/.node-red`:
14 | 
15 |     $ npm install node-red/node-red-auth-github
16 | 
17 | ## Usage
18 | 
19 | ### Register a new GitHub application
20 | 
21 | To enable access control with GitHub, you must first [register a new application
22 | on your GitHub account](https://github.com/settings/developers).
23 | 
24 | Once created, you will be provided a _Client ID_ and _Client Secret_ that
25 | you will need to use to configure the authentication plugin.
26 | 
27 | ### Configure `adminAuth`
28 | 
29 | Access control for the Node-RED editor is configured in your `settings.js` file
30 | using the `adminAuth` property.
31 | 
32 |     adminAuth: require('node-red-auth-github')({
33 |         clientID: GITHUB_CLIENT_ID,
34 |         clientSecret: GITHUB_CLIENT_SECRET,
35 |         baseURL: "http://localhost:1880/",
36 |         users: [
37 |            { username: "knolleary",permissions: ["*"]}
38 |         ]
39 |     })
40 | 
41 | The `baseURL` property is the URL used to access the Node-RED editor.
42 | 
43 | The `users` property is the list of GitHub users who are allowed to access the
44 | editor. It is the same as used by `adminAuth` as described in the [security documentation](http://nodered.org/docs/security), but without the `password` property.
45 | 
46 | A default user can be specified by adding a `default` property to the options object:
47 | 
48 |         users: [
49 |            ...
50 |         ],
51 |         default: {
52 |             permissions: "read"
53 |         }
54 | 
55 | ## Copyright and license
56 | 
57 | Copyright JS Foundation and other contributors, http://js.foundation under [the Apache 2.0 license](LICENSE).
58 | 


--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * Copyright JS Foundation and other contributors, http://js.foundation
 3 |  *
 4 |  * Licensed under the Apache License, Version 2.0 (the "License");
 5 |  * you may not use this file except in compliance with the License.
 6 |  * You may obtain a copy of the License at
 7 |  *
 8 |  * http://www.apache.org/licenses/LICENSE-2.0
 9 |  *
10 |  * Unless required by applicable law or agreed to in writing, software
11 |  * distributed under the License is distributed on an "AS IS" BASIS,
12 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 |  * See the License for the specific language governing permissions and
14 |  * limitations under the License.
15 |  **/
16 | 
17 | var path = require("path");
18 | var githubStrategy = require("passport-github");
19 | 
20 | var requiredOptions = [
21 |     'clientID',
22 |     'clientSecret',
23 |     'baseURL',
24 |     'users'
25 | ];
26 | 
27 | module.exports = function(opts) {
28 |     for (var i=0;i<requiredOptions.length;i++) {
29 |         if (!opts.hasOwnProperty(requiredOptions[i])) {
30 |             throw new Error("Missing auth option: "+requiredOptions[i]);
31 |         }
32 |     }
33 | 
34 |     var callbackURL = opts.baseURL+
35 |         ((opts.baseURL[opts.baseURL.length-1] === "/")?"":"/")+
36 |         "auth/strategy/callback";
37 | 
38 |     var adminAuth = {
39 |         type:"strategy",
40 |         strategy: {
41 |             name: "github",
42 |             label: 'Sign in with GitHub',
43 |             icon:"fa-github",
44 |             strategy: githubStrategy.Strategy,
45 |             options: {
46 |                 clientID: opts.clientID,
47 |                 clientSecret: opts.clientSecret,
48 |                 callbackURL: callbackURL,
49 |                 verify: function(accessToken, refreshToken, profile, done) {
50 |                     done(null,profile);
51 |                 }
52 |             }
53 |         },
54 |         users: opts.users
55 |     };
56 |     if (opts.hasOwnProperty('default')) {
57 |         adminAuth.default = opts.default;
58 |     }
59 | 
60 |     return adminAuth;
61 | 
62 | };
63 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | Copyright JS Foundation and other contributors, http://js.foundation
  2 | 
  3 |                                  Apache License
  4 |                            Version 2.0, January 2004
  5 |                         http://www.apache.org/licenses/
  6 | 
  7 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  8 | 
  9 |    1. Definitions.
 10 | 
 11 |       "License" shall mean the terms and conditions for use, reproduction,
 12 |       and distribution as defined by Sections 1 through 9 of this document.
 13 | 
 14 |       "Licensor" shall mean the copyright owner or entity authorized by
 15 |       the copyright owner that is granting the License.
 16 | 
 17 |       "Legal Entity" shall mean the union of the acting entity and all
 18 |       other entities that control, are controlled by, or are under common
 19 |       control with that entity. For the purposes of this definition,
 20 |       "control" means (i) the power, direct or indirect, to cause the
 21 |       direction or management of such entity, whether by contract or
 22 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 23 |       outstanding shares, or (iii) beneficial ownership of such entity.
 24 | 
 25 |       "You" (or "Your") shall mean an individual or Legal Entity
 26 |       exercising permissions granted by this License.
 27 | 
 28 |       "Source" form shall mean the preferred form for making modifications,
 29 |       including but not limited to software source code, documentation
 30 |       source, and configuration files.
 31 | 
 32 |       "Object" form shall mean any form resulting from mechanical
 33 |       transformation or translation of a Source form, including but
 34 |       not limited to compiled object code, generated documentation,
 35 |       and conversions to other media types.
 36 | 
 37 |       "Work" shall mean the work of authorship, whether in Source or
 38 |       Object form, made available under the License, as indicated by a
 39 |       copyright notice that is included in or attached to the work
 40 |       (an example is provided in the Appendix below).
 41 | 
 42 |       "Derivative Works" shall mean any work, whether in Source or Object
 43 |       form, that is based on (or derived from) the Work and for which the
 44 |       editorial revisions, annotations, elaborations, or other modifications
 45 |       represent, as a whole, an original work of authorship. For the purposes
 46 |       of this License, Derivative Works shall not include works that remain
 47 |       separable from, or merely link (or bind by name) to the interfaces of,
 48 |       the Work and Derivative Works thereof.
 49 | 
 50 |       "Contribution" shall mean any work of authorship, including
 51 |       the original version of the Work and any modifications or additions
 52 |       to that Work or Derivative Works thereof, that is intentionally
 53 |       submitted to Licensor for inclusion in the Work by the copyright owner
 54 |       or by an individual or Legal Entity authorized to submit on behalf of
 55 |       the copyright owner. For the purposes of this definition, "submitted"
 56 |       means any form of electronic, verbal, or written communication sent
 57 |       to the Licensor or its representatives, including but not limited to
 58 |       communication on electronic mailing lists, source code control systems,
 59 |       and issue tracking systems that are managed by, or on behalf of, the
 60 |       Licensor for the purpose of discussing and improving the Work, but
 61 |       excluding communication that is conspicuously marked or otherwise
 62 |       designated in writing by the copyright owner as "Not a Contribution."
 63 | 
 64 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 65 |       on behalf of whom a Contribution has been received by Licensor and
 66 |       subsequently incorporated within the Work.
 67 | 
 68 |    2. Grant of Copyright License. Subject to the terms and conditions of
 69 |       this License, each Contributor hereby grants to You a perpetual,
 70 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 71 |       copyright license to reproduce, prepare Derivative Works of,
 72 |       publicly display, publicly perform, sublicense, and distribute the
 73 |       Work and such Derivative Works in Source or Object form.
 74 | 
 75 |    3. Grant of Patent License. Subject to the terms and conditions of
 76 |       this License, each Contributor hereby grants to You a perpetual,
 77 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 78 |       (except as stated in this section) patent license to make, have made,
 79 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 80 |       where such license applies only to those patent claims licensable
 81 |       by such Contributor that are necessarily infringed by their
 82 |       Contribution(s) alone or by combination of their Contribution(s)
 83 |       with the Work to which such Contribution(s) was submitted. If You
 84 |       institute patent litigation against any entity (including a
 85 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 86 |       or a Contribution incorporated within the Work constitutes direct
 87 |       or contributory patent infringement, then any patent licenses
 88 |       granted to You under this License for that Work shall terminate
 89 |       as of the date such litigation is filed.
 90 | 
 91 |    4. Redistribution. You may reproduce and distribute copies of the
 92 |       Work or Derivative Works thereof in any medium, with or without
 93 |       modifications, and in Source or Object form, provided that You
 94 |       meet the following conditions:
 95 | 
 96 |       (a) You must give any other recipients of the Work or
 97 |           Derivative Works a copy of this License; and
 98 | 
 99 |       (b) You must cause any modified files to carry prominent notices
100 |           stating that You changed the files; and
101 | 
102 |       (c) You must retain, in the Source form of any Derivative Works
103 |           that You distribute, all copyright, patent, trademark, and
104 |           attribution notices from the Source form of the Work,
105 |           excluding those notices that do not pertain to any part of
106 |           the Derivative Works; and
107 | 
108 |       (d) If the Work includes a "NOTICE" text file as part of its
109 |           distribution, then any Derivative Works that You distribute must
110 |           include a readable copy of the attribution notices contained
111 |           within such NOTICE file, excluding those notices that do not
112 |           pertain to any part of the Derivative Works, in at least one
113 |           of the following places: within a NOTICE text file distributed
114 |           as part of the Derivative Works; within the Source form or
115 |           documentation, if provided along with the Derivative Works; or,
116 |           within a display generated by the Derivative Works, if and
117 |           wherever such third-party notices normally appear. The contents
118 |           of the NOTICE file are for informational purposes only and
119 |           do not modify the License. You may add Your own attribution
120 |           notices within Derivative Works that You distribute, alongside
121 |           or as an addendum to the NOTICE text from the Work, provided
122 |           that such additional attribution notices cannot be construed
123 |           as modifying the License.
124 | 
125 |       You may add Your own copyright statement to Your modifications and
126 |       may provide additional or different license terms and conditions
127 |       for use, reproduction, or distribution of Your modifications, or
128 |       for any such Derivative Works as a whole, provided Your use,
129 |       reproduction, and distribution of the Work otherwise complies with
130 |       the conditions stated in this License.
131 | 
132 |    5. Submission of Contributions. Unless You explicitly state otherwise,
133 |       any Contribution intentionally submitted for inclusion in the Work
134 |       by You to the Licensor shall be under the terms and conditions of
135 |       this License, without any additional terms or conditions.
136 |       Notwithstanding the above, nothing herein shall supersede or modify
137 |       the terms of any separate license agreement you may have executed
138 |       with Licensor regarding such Contributions.
139 | 
140 |    6. Trademarks. This License does not grant permission to use the trade
141 |       names, trademarks, service marks, or product names of the Licensor,
142 |       except as required for reasonable and customary use in describing the
143 |       origin of the Work and reproducing the content of the NOTICE file.
144 | 
145 |    7. Disclaimer of Warranty. Unless required by applicable law or
146 |       agreed to in writing, Licensor provides the Work (and each
147 |       Contributor provides its Contributions) on an "AS IS" BASIS,
148 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149 |       implied, including, without limitation, any warranties or conditions
150 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151 |       PARTICULAR PURPOSE. You are solely responsible for determining the
152 |       appropriateness of using or redistributing the Work and assume any
153 |       risks associated with Your exercise of permissions under this License.
154 | 
155 |    8. Limitation of Liability. In no event and under no legal theory,
156 |       whether in tort (including negligence), contract, or otherwise,
157 |       unless required by applicable law (such as deliberate and grossly
158 |       negligent acts) or agreed to in writing, shall any Contributor be
159 |       liable to You for damages, including any direct, indirect, special,
160 |       incidental, or consequential damages of any character arising as a
161 |       result of this License or out of the use or inability to use the
162 |       Work (including but not limited to damages for loss of goodwill,
163 |       work stoppage, computer failure or malfunction, or any and all
164 |       other commercial damages or losses), even if such Contributor
165 |       has been advised of the possibility of such damages.
166 | 
167 |    9. Accepting Warranty or Additional Liability. While redistributing
168 |       the Work or Derivative Works thereof, You may choose to offer,
169 |       and charge a fee for, acceptance of support, warranty, indemnity,
170 |       or other liability obligations and/or rights consistent with this
171 |       License. However, in accepting such obligations, You may act only
172 |       on Your own behalf and on Your sole responsibility, not on behalf
173 |       of any other Contributor, and only if You agree to indemnify,
174 |       defend, and hold each Contributor harmless for any liability
175 |       incurred by, or claims asserted against, such Contributor by reason
176 |       of your accepting any such warranty or additional liability.
177 | 
178 |    END OF TERMS AND CONDITIONS
179 | 


--------------------------------------------------------------------------------