🌱 Add sendFingerprint option to signIn #82

lboyette-okta · 2018-01-11T23:04:35Z

Add sendFingerprint option to attach a fingerprint to the signIn call

dannavarro-okta · 2018-01-12T02:32:22Z

README.md

@@ -132,6 +132,7 @@ The goal of an authentication flow is to [set an Okta session cookie on the user

  - `username` - User’s non-qualified short-name (e.g. dade.murphy) or unique fully-qualified login (e.g [email protected])
  - `password` - The password of the user
+  - `sendFingerprint` -  Enabling this will send a `X-Device-Fingerprint` header. Defaults to `false`


it should probably be noted that this is only honored with certain features. We would be able to get a fingerprint without any features but from a usability standpoint, it is only used in conjunction with certain FFs. In fact I think we ignore the header if the flags are not enabled

We occasionally include features behind FF (OIDC is an example). As long as sending the header doesn't break anything, I'm not too worried about it.

nit: I believe there is an extra space in - Enabling

mauriciocastillosilva-okta

a couple of comments, but in general is looking good

mauriciocastillosilva-okta · 2018-01-12T03:10:57Z

lib/clientBuilder.js

-  return tx.postToTransaction(this, '/api/v1/authn', opts);
+  var sdk = this;
+  var body = opts || {};
+  return new Q(!body.sendFingerprint ? {} :


would it be better that if we don't have the sendFingerprint option we just do what we were doing before?

if (!body.sendFingerprint) { return tx.postToTransaction(this, '/api/v1/authn', opts); } else { return new Q(sdk.fingerprint() ... }

Doing it the way we have it now prevents me from having tx.postToTransaction twice

You're right though, I think it'd be cleaner your way

mauriciocastillosilva-okta · 2018-01-12T03:56:55Z

lib/clientBuilder.js

+  return new Q(!body.sendFingerprint ? {} :
+    sdk.fingerprint()
+    .then(function(fingerprint) {
+      return {


another option would be to just add it to opts directly, and that way you don't need to create body nor add it to tx.postToTransacton... just an idea to save a variable, but either works

opts['headers']['X-Device-Fingerprint'] = fingerprint;

I could remove the body variable declaration above, but I'll still need to do it below to delete the sendFingerprint property without affecting the opts object they passed in.

var body = util.clone(opts || {}); delete body.sendFingerprint;

If we're really opposed to the variable declaration, it could be:

opts = util.clone(opts || {}); delete opts.sendFingerprint;

not opposed, was just throwing an idea... but you are right, changing opts directly is not a good practice, much better to just pass the extra argument to http.post and let it deal with merging the options. So all good 👍

dannavarro-okta · 2018-01-12T20:57:45Z

@rameshbhojan-okta @srinivasanagandla-okta FYI

mauriciocastillosilva-okta

minor nits, and just one thing left that I didn't see the first time: if we have a test for sendFingerprint: undefined already, then we are good, if not, it might be worth adding one.

mauriciocastillosilva-okta · 2018-01-13T00:28:33Z

README.md

@@ -132,6 +132,7 @@ The goal of an authentication flow is to [set an Okta session cookie on the user

  - `username` - User’s non-qualified short-name (e.g. dade.murphy) or unique fully-qualified login (e.g [email protected])
  - `password` - The password of the user
+  - `sendFingerprint` -  Enabling this will send a `X-Device-Fingerprint` header. Defaults to `false`


nit: I believe there is an extra space in - Enabling

mauriciocastillosilva-okta · 2018-01-13T00:31:26Z

lib/tx.js

@@ -48,8 +48,8 @@ function transactionExists(sdk) {
  return !!sdk.tx.exists._getCookie(config.STATE_TOKEN_COOKIE_NAME);
 }

-function postToTransaction(sdk, url, options) {
-  return http.post(sdk, url, options)
+function postToTransaction(sdk, url, body, options) {


nit: we could name it args instead of body just for sake of consistency with http.post signature

mauriciocastillosilva-okta · 2018-01-13T00:39:32Z

test/spec/fingerprint.js

+        return setup({ authClient: test.oa }).signIn({
+          username: 'not',
+          password: 'real',
+          sendFingerprint: true


not sure if we have one test already, but if not maybe we should add one with sendFingerprint: false or sendFingerptint: undefined

We have tests for signIn that don't pass sendFingerprint, but none that send false

mauriciocastillosilva-okta

looks good to me ⛵️

lboyette-okta requested a review from mauriciocastillosilva-okta January 11, 2018 23:10

lboyette-okta changed the title ~~🌱 Add sendFingerprint option on signIn~~ 🌱 Add sendFingerprint option to signIn Jan 11, 2018

🌱 Add sendFingerprint option on signIn

9ec3fca

lboyette-okta force-pushed the lb-enable-fingerprint branch from 1ed77ab to 9ec3fca Compare January 11, 2018 23:31

dannavarro-okta reviewed Jan 12, 2018

View reviewed changes

mauriciocastillosilva-okta reviewed Jan 12, 2018

View reviewed changes

lboyette-okta force-pushed the lb-enable-fingerprint branch from b059818 to a3f0bd6 Compare January 12, 2018 19:43

Address feedback

a3f0bd6

mauriciocastillosilva-okta reviewed Jan 13, 2018

View reviewed changes

lboyette-okta force-pushed the lb-enable-fingerprint branch from b858669 to 171368a Compare January 16, 2018 17:58

Address nits

171368a

mauriciocastillosilva-okta approved these changes Jan 16, 2018

View reviewed changes

lboyette-okta merged commit aa82bc4 into master Jan 17, 2018

jmelberg-okta deleted the lb-enable-fingerprint branch June 15, 2018 16:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌱 Add sendFingerprint option to signIn #82

🌱 Add sendFingerprint option to signIn #82

lboyette-okta commented Jan 11, 2018 •

edited

Loading

dannavarro-okta Jan 12, 2018

lboyette-okta Jan 12, 2018

mauriciocastillosilva-okta Jan 13, 2018

mauriciocastillosilva-okta left a comment

mauriciocastillosilva-okta Jan 12, 2018

lboyette-okta Jan 12, 2018 •

edited

Loading

lboyette-okta Jan 12, 2018

mauriciocastillosilva-okta Jan 12, 2018

lboyette-okta Jan 12, 2018 •

edited

Loading

lboyette-okta Jan 12, 2018

mauriciocastillosilva-okta Jan 12, 2018

dannavarro-okta commented Jan 12, 2018

mauriciocastillosilva-okta left a comment

mauriciocastillosilva-okta Jan 13, 2018

mauriciocastillosilva-okta Jan 13, 2018

mauriciocastillosilva-okta Jan 13, 2018

lboyette-okta Jan 16, 2018 •

edited

Loading

mauriciocastillosilva-okta left a comment

🌱 Add sendFingerprint option to signIn #82

🌱 Add sendFingerprint option to signIn #82

Conversation

lboyette-okta commented Jan 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mauriciocastillosilva-okta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta Jan 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta Jan 12, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dannavarro-okta commented Jan 12, 2018

mauriciocastillosilva-okta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lboyette-okta Jan 16, 2018 • edited Loading

Choose a reason for hiding this comment

mauriciocastillosilva-okta left a comment

Choose a reason for hiding this comment

lboyette-okta commented Jan 11, 2018 •

edited

Loading

lboyette-okta Jan 12, 2018 •

edited

Loading

lboyette-okta Jan 12, 2018 •

edited

Loading

lboyette-okta Jan 16, 2018 •

edited

Loading