Updated BASIC AUTH support #172

egeek · 2014-04-02T21:59:36Z

Added BASIC AUTH support to the current version of iodocs. Support for BASIC AUTH was the subject of these previous pull requests:

#73
#63
#32

and these issues:

#157 - the "rejectUnauthorized" flag in app.js in this patch allows self-signed certs. The initial value of this could be moved to a configuration flag instead of always being fale.
#10

This change adds support for BASIC AUTH. In apiconfig.json set the auth type to basic

"auth":"basicAuth"

for any API requiring basic authorization. This will result in the apiKey on the page being replaced with username and password fields.

Note that this pull request does not address using basic auth and apikey at the same time. It would be good if this change could be merged in, then extended to support using both auth types at the same time later.

KramKroc · 2014-04-02T22:17:58Z

It would be great if this was accepted.

- added support for unsigned certs

mansilladev · 2014-04-04T22:13:30Z

app.js

@@ -56,7 +56,7 @@ if (argv.help) {
 // Configuration
 var configFilePath = path.resolve(argv['config-file']);
 try {
-    var config = require(configFilePath);
+    var config = require('./config.json');


Perhaps we should nix this line change because we've merged in the use of optimist which allows optional use of command line flag to set configFilePath. e.g.

node app.js --config-file=/foo/bar/test1.json

Absolutely. Would you like me to submit a new pull request or can you
change the line during the merge?
On 4 Apr 2014 23:13, "Neil Mansilla" notifications@github.com wrote:

In app.js:

@@ -56,7 +56,7 @@ if (argv.help) {
// Configuration
var configFilePath = path.resolve(argv['config-file']);
try {

var config = require(configFilePath);

var config = require('./config.json');

Perhaps we should nix this line change because we've merged in the use of
optimist which allows optional use of command line flag to set
configFilePath. e.g.

node app.js --config-file=/foo/bar/test1.json

Reply to this email directly or view it on GitHubhttps://github.com//pull/172/files#r11316196
.

mansilladev · 2014-04-04T22:50:53Z

Would you ever have a case where you would want both auth by API key && with basic auth?

egeek · 2014-04-05T08:24:33Z

I can't think of a case where we'd need both basic auth and API key auth at the same time.

challgren · 2014-04-05T10:30:31Z

I have a site where that is in use right now.
On Apr 5, 2014 3:24 AM, "Stephen Houston" notifications@github.com wrote:

I can't think of a case where we'd need both basic auth and API key auth
at the same time.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/172#issuecomment-39632236
.

egeek · 2014-04-05T12:39:47Z

Both basic auth and apikey in the header? Are they both used for auth or
does one take precedence over the other?
On 5 Apr 2014 11:30, "Chris Hallgren" notifications@github.com wrote:

I have a site where that is in use right now.
On Apr 5, 2014 3:24 AM, "Stephen Houston" notifications@github.com
wrote:

I can't think of a case where we'd need both basic auth and API key auth
at the same time.

Reply to this email directly or view it on GitHub<
https://github.com/mashery/iodocs/pull/172#issuecomment-39632236>
.

Reply to this email directly or view it on GitHubhttps://github.com//pull/172#issuecomment-39634315
.

challgren · 2014-04-05T17:51:07Z

I just use http basic auth and a api key as a parameter
On Apr 5, 2014 7:39 AM, "Stephen Houston" notifications@github.com wrote:

Both basic auth and apikey in the header? Are they both used for auth or
does one take precedence over the other?
On 5 Apr 2014 11:30, "Chris Hallgren" notifications@github.com wrote:

I have a site where that is in use right now.
On Apr 5, 2014 3:24 AM, "Stephen Houston" notifications@github.com
wrote:

I can't think of a case where we'd need both basic auth and API key
auth
at the same time.

Reply to this email directly or view it on GitHub<
https://github.com/mashery/iodocs/pull/172#issuecomment-39632236>
.

Reply to this email directly or view it on GitHub<
https://github.com/mashery/iodocs/pull/172#issuecomment-39634315>
.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/172#issuecomment-39636689
.

egeek · 2014-04-06T14:13:08Z

@challgren Do you expect API Key on the header or on the query string? How are you handling having IODocs send both of these at the minute?

challgren · 2014-04-06T21:38:05Z

Originally it was in the headers but since I used iodocs we had to write a patch to accept it as a query string parameter.

egeek · 2014-04-07T21:56:52Z

@challgren Can you continue to use that method? I'm not sure what we could set the value of "auth" to that would convey using both the Basic Auth and API Key forms of authentication on a single request.

challgren · 2014-04-07T22:04:16Z

Yep it only took 1 line of code for me to use the query parameter over the
header
On Apr 7, 2014 4:56 PM, "Stephen Houston" notifications@github.com wrote:

@challgren https://github.com/challgren Can you continue to use that
method? I'm not sure what we could set the value of "auth" to that would
convey using both the Basic Auth and API Key forms of authentication on a
single request.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/172#issuecomment-39788935
.

egeek · 2014-04-07T22:06:48Z

Cool @challgren

@mansilladev Think we are ok to merge in this pull request? Is there anything else we need to do?

mlconnor · 2014-05-23T14:41:55Z

This looks really good, I need this desperately. Right now, I'm running off egeeks fork. Thanks for the mods egeek.

mlconnor · 2014-05-23T15:54:08Z

One thing to point out, app.js line 814 throws an error if your config doesn't have any header data in it. I think the following should be added...

        if (apiConfig.auth == 'basicAuth') {
            if ( typeof options.headers == "undefined" ) {
              options.headers = {} ;
            }

mansilladev · 2014-10-07T20:42:54Z

Basic auth feature added for both Node server level and API request level.

matthewsmoore · 2014-10-14T23:35:36Z

I was super excited to see that iodocs has added support for HTTP Basic Auth. I cannot seem to get it to work. Could you possibly help me a bit?

I’ve just in the last hour grabbed the latest code from:
git clone http://github.com/mashery/iodocs.git

but no matter where I make the change:
"auth":"basicAuth"

The IO docs page for the API is asking for an API Key and not a Username & Password.

By any chance do you have an example set of config file(s) that demonstrate how to configure basic auth?

Thanks so much!
-Matt

phairow · 2014-10-15T00:04:27Z

@matthewsmoore It looks like this API level basic auth feature no longer exists. also looks like the Node server level basic auth is broken. Fixing right now!

phairow · 2014-10-15T00:06:40Z

opened #217 and #216 to track these respectively

phairow · 2014-10-15T00:36:53Z

@matthewsmoore Both should work now, let me know if anything else needs fixing

matthewsmoore · 2014-10-15T02:06:51Z

WOW! That was fast. Got latest and it is now working exactly, perfectly right. Thank you!

phairow · 2014-10-15T07:01:29Z

@matthewsmoore Awesome! The code was there in the original PR but somehow it was lost in translation. Glad to hear it's working as expected :)

amilkr · 2015-01-16T21:18:49Z

+1 to this feature

egeek and others added 5 commits April 3, 2014 00:35

Added basic auth support

acbc80a

- fixed jade

e610bd1

- added support for unsigned certs

Added basic auth support

f96dec1

- fixed jade

2392ad8

- added support for unsigned certs

Fixed clone

3bd6bbd

mansilladev reviewed Apr 4, 2014
View reviewed changes

mansilladev added auth labels Apr 4, 2014

mansilladev closed this Oct 7, 2014

phairow mentioned this pull request Oct 10, 2014

Using IO Docs with self signed certificates and basic authentication #157

Closed

phairow reopened this Oct 15, 2014

This was referenced Oct 15, 2014

fix Node server basic auth #216

Closed

fix api level basic auth #217

Open

phairow closed this Oct 15, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated BASIC AUTH support #172

Updated BASIC AUTH support #172

egeek commented Apr 2, 2014

KramKroc commented Apr 2, 2014

mansilladev Apr 4, 2014

egeek Apr 4, 2014

mansilladev commented Apr 4, 2014

egeek commented Apr 5, 2014

challgren commented Apr 5, 2014

egeek commented Apr 5, 2014

challgren commented Apr 5, 2014

egeek commented Apr 6, 2014

challgren commented Apr 6, 2014

egeek commented Apr 7, 2014

challgren commented Apr 7, 2014

egeek commented Apr 7, 2014

mlconnor commented May 23, 2014

mlconnor commented May 23, 2014

mansilladev commented Oct 7, 2014

matthewsmoore commented Oct 14, 2014

phairow commented Oct 15, 2014

phairow commented Oct 15, 2014

phairow commented Oct 15, 2014

matthewsmoore commented Oct 15, 2014

phairow commented Oct 15, 2014

amilkr commented Jan 16, 2015

Updated BASIC AUTH support #172

Updated BASIC AUTH support #172

Conversation

egeek commented Apr 2, 2014

KramKroc commented Apr 2, 2014

mansilladev Apr 4, 2014

Choose a reason for hiding this comment

egeek Apr 4, 2014

Choose a reason for hiding this comment

mansilladev commented Apr 4, 2014

egeek commented Apr 5, 2014

challgren commented Apr 5, 2014

egeek commented Apr 5, 2014

challgren commented Apr 5, 2014

egeek commented Apr 6, 2014

challgren commented Apr 6, 2014

egeek commented Apr 7, 2014

challgren commented Apr 7, 2014

egeek commented Apr 7, 2014

mlconnor commented May 23, 2014

mlconnor commented May 23, 2014

mansilladev commented Oct 7, 2014

matthewsmoore commented Oct 14, 2014

phairow commented Oct 15, 2014

phairow commented Oct 15, 2014

phairow commented Oct 15, 2014

matthewsmoore commented Oct 15, 2014

phairow commented Oct 15, 2014

amilkr commented Jan 16, 2015