Add js Auth example with WEB server Flow

Paulo Cabral · waldyrious · commit a1b5f0ea1ddb · 2020-11-10T18:19:55.000Z
diff --git a/rest-api/javascript/authentication/web-application-flow/.env.example b/rest-api/javascript/authentication/web-application-flow/.env.example
@@ -0,0 +1,6 @@
+# Base Url endpoint
+BASE_URL='https://api-sandbox.uphold.com'
+
+CLIENT_ID = ''
+CLIENT_SECRET = ''
+SERVER_PORT = 3000
diff --git a/rest-api/javascript/authentication/web-application-flow/README.md b/rest-api/javascript/authentication/web-application-flow/README.md
@@ -0,0 +1,21 @@
+# Client credentials web-flow
+
+This sample project demonstrates how to authenticate in the Uphold API using the client credentials web flow. For further background, please refer to the [API documentation](https://uphold.com/en/developer/api/documentation)
+
+## Summary
+**Ideal for web applications** that wish to retrieve information about a user’s Uphold account or take actions on their behalf.
+This example tries to mimic the WEB-FLOW cycle. It creates a simple webserver and tries to run the entire cycle of authenticating against UPHOLD servers and return the token to this web server.
+
+    ```
+    https://sandbox.uphold.com/authorize/PUT_HERE_YOUR_CLIENT_ID?scope=user:read&state=PUT_A_CODE_HERE_TO_IDENTIFY_THE_REQUEST
+    ```
+
+## Requirements
+- `node` v13.14.0 +
+
+## Setup
+- run `npm install` (or `yarn install`)
+- create a `.env` file based on the `.env.example` file, and populate it with the required data
+
+## Run
+- run `node index.js`
diff --git a/rest-api/javascript/authentication/web-application-flow/cert.pem b/rest-api/javascript/authentication/web-application-flow/cert.pem
@@ -0,0 +1,27 @@
+-----BEGIN CERTIFICATE-----
+MIIEljCCAn4CCQCHHmqArzJctTANBgkqhkiG9w0BAQsFADANMQswCQYDVQQGEwJw
+dDAeFw0yMDEwMjIxMzE1MTlaFw0yMTEwMjIxMzE1MTlaMA0xCzAJBgNVBAYTAnB0
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArsxVWb12Rmn7oocPIXe5
+SgiiRAqS4pZ2jnpxkN2rYp8sBBZCYAkRFNfIh+SUoOVPUhrM5JDZ9stmPHAba/XO
+oOhhq4paI082TqBiBqqjYtofqdKp3FjMLXcV+Y1jYnphZ6U+eZKsLUc0hWCK/TFa
+6H5Y3EUip9t8xmNRkzo2xhd5gNTEsvFMx/1XzJVJ7T5kgjKF+SECEw3leQva1RPK
+g7+REF1McZlWqav8Y/qEQ3ZS1AIJLEHG0x1rSE9zf0PHiTYecPbYYLwMccHorKua
+owjQKt9MboFN5u+Ne99sTyLuemDBmBFEI87ecBBCDzQb/bOQoqKJDY4u1xjO5Crf
+tvVgZoGkwlXobJZ4r02Zfh338dXCIbTw9tXNV0sGtdiDMD3uPDq7+pU7mjWIcWjb
+1hNVFxOO5Bna42r8q53QkfibKTVEZZaZmOu9vosOBGa4YsYUXvh0N1TqS7jNYv2H
+vTdKYZnJvEoFj4bXEpyA8Dk/roybij19l0d5w6SR34Aq1M63NxGwph4CiCJ2SMGU
+u+y048/XH64Bn1GjE19yyZ8JKi6tiENY6m9WS4BDGFiAOL5XkthcUmI5j8yaHncr
+iSIJmfEiwL3ZCiUzD3Ua3l5oSK+aG5hf7FU9rXNYnt6byerrZasZnGi8U4y4CzLA
+VEdfuklz3fBUVqz2fU6cFEkCAwEAATANBgkqhkiG9w0BAQsFAAOCAgEAW9j6giBn
+iiphY4GMuQlQr3mf/rrtqCDIV+SAkhi/IzKbk4x/5yXoLZ2r9FbcZmNigBjQqB16
+V0YN2lNYFiSF9Sx9Qv8XIFXYyPIKucHKekGASDk8oqmPtHQYBH9hOTRN8SRaT7aQ
+rV1pYqdkjjG4gtjauYTAXucgQjP7d4kj8jOadZCffN53/6ASPRkj/Q+vpUlj0dxd
+tjrEi1NxwbHahi59UggTg6ftLTgIMOHJYWMyTuR++B8m+UT6bFpPxB5enfcL+Qg9
+4cTK0MtebyIIXmXv2L5S56/En+Kvlq3ynRFlqq9kdHK80kqjmPw6D2A+RHka1nDb
+uo61ZPxBznMk9s8SJix+lv3MvinOJCiJDjYhef0rZXSSUEmXa58IF7iZdV+SIlUp
+bEbEpCvVqBgc8XDoVcSp96rpZDSuSYfU7Xz9McyFbOtq+NkEtDevxE8r3WqIBh9x
+efss+CBkrdGyj5qyBTd8YyLKvY3fsPfS08BMN7cMZVw8wsICymAGUFHk5Do3RFxM
+tgD1VE26v0cluQwguYWZgRLR9lK1vREs7OfRb4RaXLczArOza5o4JTwmPByZ7owT
+PzK3H9ydn9oq8LoRoY+9s3IRgdRQSD/idf/QylsZ9Es4av9LO+6pvmO+Sr/rnIQb
+Gg6t7OPvwYNi62kS7eywQNbbfIB6wX0h/iw=
+-----END CERTIFICATE-----
diff --git a/rest-api/javascript/authentication/web-application-flow/index.js b/rest-api/javascript/authentication/web-application-flow/index.js
@@ -0,0 +1,110 @@
+/**
+ * Dependencies.
+ */
+import axios from "axios";
+import b64Pkg from "js-base64";
+import dotenv from "dotenv";
+import express from "express";
+import fs from "fs";
+import https from "https";
+import qs from "qs";
+import path from "path";
+
+const { encode } = b64Pkg;
+dotenv.config({ path: path.resolve() + "/.env" });
+
+// For testing purposes point your browser to the fallowing URL
+// https://sandbox.uphold.com/authorize/PUT_HERE_YOUR_CLIENT_ID?scope=user:read&state=PUT_A_CODE_STATE_HERE
+
+/**
+ * Get assets.
+ */
+async function getAssets(token) {
+  try {
+    const r = await axios.get(`${process.env.BASE_URL}/v0/assets`, {
+      headers: {
+        Authorization: `${token.token_type} ${token.access_token}`,
+      },
+    });
+    return r.data;
+  } catch (error) {
+    console.log(JSON.stringify(error, null, 2));
+    throw error;
+  }
+}
+
+/**
+ * Get Token.
+ */
+async function getToken(code) {
+  // auth encoded with client ID and Client Secret
+  // set post options for axios
+
+  const auth = encode(process.env.CLIENT_ID + ":" + process.env.CLIENT_SECRET);
+  const url = `${process.env.BASE_URL}/oauth2/token`;
+
+  const options = {
+    method: "POST",
+    headers: {
+      Authorization: "Basic " + auth,
+      "content-type": "application/x-www-form-urlencoded",
+    },
+    data: qs.stringify({ code, grant_type: "client_credentials" }),
+    url,
+  };
+
+  const data = axios(options)
+    .then((response) => {
+      return response.data;
+    })
+    .catch((error) => {
+      error.response.data.errors
+        ? console.log(JSON.stringify(error.response.data.errors, null, 2))
+        : console.log(JSON.stringify(error, null, 2));
+      throw error;
+    });
+
+  return data;
+}
+
+const app = express();
+const hostname = "localhost";
+const port = process.env.USERNAME || 3000;
+
+/**
+ * Callback url endpoint.
+ */
+
+app.get("/callback", async (req, res) => {
+  // Do we have a code?
+  // WARNING!!!!! The code only works for 5 minutes
+  if (req.query.code) {
+    console.log(`code ${req.query.code}`);
+
+    const token = await getToken(req.query.code);
+    const assets = await getAssets(token);
+
+    console.log(token);
+    console.log(assets);
+    res.send("All done !");
+  } else {
+    res.send(`Oops, something went wrong... did you pass the STATE?`);
+  }
+});
+
+/**
+ * Run server.
+ */
+
+https
+  .createServer(
+    {
+      key: fs.readFileSync("./key.pem"),
+      cert: fs.readFileSync("./cert.pem"),
+      passphrase: "test",
+    },
+    app
+  )
+  .listen(port, () => {
+    console.log(`Serving running at https://${hostname}:${port}/`);
+  });
diff --git a/rest-api/javascript/authentication/web-application-flow/key.pem b/rest-api/javascript/authentication/web-application-flow/key.pem
@@ -0,0 +1,54 @@
+-----BEGIN ENCRYPTED PRIVATE KEY-----
+MIIJnzBJBgkqhkiG9w0BBQ0wPDAbBgkqhkiG9w0BBQwwDgQI68SyCq4M5TgCAggA
+MB0GCWCGSAFlAwQBKgQQDvvgtaUPRg3RCEOgo7eEUQSCCVBXCGNy/YhTUHrw1ZEg
+CId6SEvIQa7VVGNACCSA4dtRutV7IlVfpd83hODBcMq9O3fWMuH2/IhScYPRtuyz
+khbVezxrFEByznJciHR1wLN3qhrWPRb2p0dTfUVoczyjrEiblNMNQVk16PMOSATk
+I7JQIWRXPYQq4z2FVPOG+amh+m4kdHbanVWbOmLclFLWfW9xVQ8bjPOmzM6Qzskq
+tbBmRk+pqdLs84gqBuqhGvHUcTr8O9L87S2hHbmz75G3q9mTYOGfGB1vG5Ge8TKl
+5BM5w9QzB7CoqitqnJEs9V/DLM3z9uqKGA47v5NZwIzf7V1mT1yZeyQlQgFtaUKT
+1NR+LzB/JotIDSf8/ViHCYYY5ibhTON8zsSLQ/0xeAH5q9R/RvKdLfnzFZg2f8P0
+41dfq3+FVoNqo5ZGsN1JX14YutYumHAeTvWMY5Kv3GOiKF2FtDnPxThfG9uIqY0z
+KeqaLlxwQwC5QzCyyG00TT9pMk5h9lJSV1a2bK5y1L3sh/XO2M0j2N11F5t42aNz
+zaoirkeSUp8GOOAtQc5I8fsnNJ8LKU1juu0ot4agzGXhLYd285SFh+YKXe6tYyQc
+gbGdfM2q7TBjKj/1bbiU6HutgYK3XeC/jmEn8wQ89Dfi1GLr5KLL2Xv0ulAake8E
+6GkJIQJG832pb9HFgI9A+0qSvNQLZ6dVABewNgosKcpIFSZYD4tXWUERhtZouHHV
+z7/yGj6n/v4utOpAoyG9Nw8jd5bz/e01T4vFQhY0zWkAfnIo3PHob/IsAmcc7K8b
+HhA6NhRmhkEjD0YklaItZ1515ElA/3knHK3cWNy4EieRd3e28+lKbolNhBVBpl5Y
+WWX9gAgUmUfbURN5z352fIaX0GDIoeeN6wIWrvGrY+nrJi9bi4R+zsDvfDhFOOrV
+ZQNIP+kaUFf9cxjtM5PXPgl+OjtNVd3D9klxVsLsPoS7zGA+sCP1OebFZsuOF3wb
+hI//aNBToKdn5wiQIahMQQ7diHuBx/jSiNYuOZG/d8IvPB8kcAq7achyfvZAcprn
+7kU8sI0O1avr/MCNzSXYrK5AFSJTe/xwCAGuIUx+4K1SfG6/C6tFEFu3V/8HyZZA
+mq5UwAlOqos2E0fnPUUiofgico/q3b0pZVxytsGSQVbHDARAWz41IoWc1Q7kcX1g
+AqUr/3ydIIGzsomF9cnks7vB01pfT2688IchyhB7XFsdpIpehK+YbD3YdD71Txuq
+1zSuj/D4ZIOTALD06odrTFGGR3cP1VCBif3VOm9eOapQ2jr6R8SCGpTLVmhDw6eM
+yJ1IXzW5ggKxn0ON4BV/GyAV6AQhZLPaLTahv953wHXrNsaswjI4fyzbSKneKBUe
+fz80QRY82SQ+x1iS2uM2eaavyxa0U8+yW8qYTJYCFNwU7SJHdCHAnA5miuSTc7rG
+pHppe7OATa6z6XcOv8VIFfh18Jqlxy12DGyhgi5naY4Hcifjj7x/QaWZdv4V0Evx
+K1lCIkdYLT9OEnE5CehO4qdI1X+IysZxxQKSyymmV3lNx8dPM2tj3py6BXsCe9X/
+kOwy4ssimDpNkvymgEZzQklbmG4I7HLudaoBe+9DD1dLaZnU++soNDlFKXKJHsNq
+PUF6yHHdhqiTBLXz/OB2zoYdIsPYgUNozVjKSTRBOPF+cZ6WwW2KLaR14uN5M73T
++EW2AmezF6dsdS6a27TZAb15ybwZS8l5PvrlulULutwa5zsp92amyGBYg8U3gVnN
+InrbcScHJSS3Rzjv1XU4H9IxrOiWB4X9D29B8yJR0oLJ/lfHEoHYcnXexIs2pQeu
+RTRbhhsuEZwJLfdr2OBfyAqQ7iJ5nzGq4n0ibSTojImVKYxEN++PU+xkmywK1e13
+oDPrBI/WZIDfma/hEmcznu/ETgHMgiNck2RkH0qCNR/VgPeg9F+s7ytetgs9f9Nc
+lwSsUNP2V1XrQRIvFpyLuSAILJTC6k/zv/TPo5Dvrq2PVGL9ZB5kqJs+07qhZ8t9
+wg2DUTTt4PHv5Kq+TZD55swMKcYvbQwp98X0ZJjylWlwTePwfMDNzB7cc2kAWmbT
+A5aDdkqLmLnXQDT/dy3R6Ve2Yjwm7sN1ro6Teiw/94EzwnuFCFnBYartjyXtacKO
+r0MZ6Y/yimXwEZuhWJzwoS2sOMa2Hwz/Ebu3pZHbzNI89aL/06gqarYnfH+MjNZ1
+R1+lR2Su16SW8wo/i4kxO4LVIqyfAqUPwTeDLz7QBlr07eLqGiGbsVBveaofZ7TA
+DNoaYND/ygJFZ8I7Pj2iG9UR5qFDCm8hojxdDgVSX7NYnPGKPg6qYigIH5j48B94
+x13zsbhGDSnmiPu9OdNTneQRd3Vd8GaJsDUDqmEWqHHEzSJU4TWwgaOZR36Q2D9r
+zuWDzBSDq3JX1ia9lcrtofP0gMJavWYIaj+RQChwq9CI+ReoC6Iq4SzOV2JIvxmf
+/b5GQWAALHA/Lh1aiurHAYLBYaWv2dnOCABSaOXAMTWZDGKKHWVwDh6NNHtgXRvU
+rNYc1P3LKpW7xAT0ZSrQnteCqOMF21yrAtN5vw4Lub71P/0JlAL4Zee2d48ACGog
+5UnYTMizXIiOhudKQV7Qmkb0EDb5wnY7r9qjrmhEgzZw1cI/bOVumwSv5KspsyDG
+T0bxhoNZR7mZfWxUOpIadJi6DuDOg6bFo+X+KwAX/2x3+Wy7WVG5/SV2/QpDVg9l
+ncIo4OMagwrQfEzsU2AlcuIPhNPR+fiVZjGp2VkBdglV8B30cmohf9arxXPyVb4p
+WyVOIeFwpMh0ZtVcinlVNBpB/2vzeqGugwNww4u9BQZ6ZxiEoPQAGImL4I9pCPHb
+4FWKCxudVndt9Sa5NvypR1kbAKG7FLgkT3l9/f9XkpijZ1bkNkf2WN6FHL1WL5Og
+zAZD6uP3flQP3Km9k5BDNOQEuRyfX+eoFRFDhrk6W4wHXwlRDfysR6xdtMzsYUMi
+RlFL274VOYK4zxcMSPQrVTN8+5PJ8FPOl7Ig0nhL4uXdz2mR7d51PppPiDOufKwp
+rhT3HkpCKV/4bDcCxb3/9VojTtffx8XiKw9gXVeI6zD4NOuBHQgwqrS5NQQiE6ak
+al9Af+amOJgFbdmz0q/FgbiJ7LOAXUsOtAlbe2NtKT4x39+LPfff4U0/52l15CNK
+idnWYlp+GmR0sckgYM6+f3R+PQ==
+-----END ENCRYPTED PRIVATE KEY-----
diff --git a/rest-api/javascript/authentication/web-application-flow/package.json b/rest-api/javascript/authentication/web-application-flow/package.json
@@ -0,0 +1,21 @@
+{
+    "name": "uphold-wap",
+    "version": "0.0.1",
+    "description": "Uphold rest Api test web application flow example",
+    "license": "MIT",
+    "type": "module",
+    "main": "app.js",
+    "dependencies": {
+        "axios": "^0.20.0",        
+        "dotenv": "^8.2.0",
+        "express": "^4.17.1",
+        "js-base64": "^3.5.2",
+        "nodemon": "^2.0.2"
+    },
+    "engines": {
+        "node": ">=13"
+    },
+    "scripts": {
+        "run": "nodemon --inspect index.js "
+    }
+}
diff --git a/rest-api/javascript/authentication/web-application-flow/yarn.lock b/rest-api/javascript/authentication/web-application-flow/yarn.lock
