react-native-azure-auth-encrypted
Version:
Azure AD authentication in React Native using encrypted storage
209 lines (175 loc) • 11 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>token/cache.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Auth.html">Auth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.acquireTokenSilent">acquireTokenSilent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.clearPersistenCache">clearPersistenCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.exchange">exchange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.loginUrl">loginUrl</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.logoutUrl">logoutUrl</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.msGraphRequest">msGraphRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Auth.html#.refreshTokens">refreshTokens</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AzureAuth.html">AzureAuth</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="BaseError.html">BaseError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Client.html">Client</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.AccessTokenItem.html">AccessTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.BaseTokenItem.html">BaseTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.RefreshTokenItem.html">RefreshTokenItem</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.Scope.html">Scope</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="TokenCache.TokenCache.html">TokenCache</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="WebAuth.html">WebAuth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="WebAuth.html#.authorize">authorize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="WebAuth.html#.clearSession">clearSession</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAllUserTokenKeys">getAllUserTokenKeys</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isIntersects">isIntersects</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isSubsetOf">isSubsetOf</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#request">request</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#serializeParams">serializeParams</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#validate">validate</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">token/cache.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import AsyncStorage from '@react-native-async-storage/async-storage'
import { validate } from '../utils/validate'
import AccessTokenItem from './accessTokenItem'
import RefreshTokenItem from './refreshTokenItem'
import BaseTokenItem from './baseTokenItem'
/**
* Token persistent cache
*
* @namespace TokenCache
*
* @param {Object} input - init parameters
* @param {String} input.clientId
* @param {Boolean} input.persistent - if true - the RN `AsyncStorage` is used for persistent caching,
* otherwise only the class instance. (default: true)
*
* @class TokenCache
* @memberof TokenCache
*/
export default class TokenCache {
static _instance
constructor(input = {}) {
// for better testability check params first
const params = validate({
parameters: {
clientId: { required: true },
persistent: { required: false, type: 'boolean' },
}
}, input)
if (TokenCache._instance) {
return TokenCache._instance
}
this.cache = {}
this.clientId = params.clientId
this.persistent = params.persistent != null ? params.persistent : true // by default enabled
TokenCache._instance = this
}
async saveAccessToken(tokenResponse) {
let accessToken = new AccessTokenItem(tokenResponse, this.clientId)
const key = accessToken.tokenKey()
// remove scope intersection
const userTokens = await this.getAllUserTokenKeys(accessToken.userId)
userTokens.forEach((uTokenKey) => {
const scopeFormKey = BaseTokenItem.scopeFromKey(uTokenKey)
if (scopeFormKey && !accessToken.scope.equals(scopeFormKey) &&
accessToken.scope.isIntersects(scopeFormKey)) {
this.removeToken(uTokenKey)
}
})
this.cache[key] = accessToken.toString()
if (this.persistent) {
AsyncStorage.setItem(key, accessToken.toString())
//.catch(err => { return err /* log error?*/ })
}
return accessToken
}
saveRefreshToken(tokenResponse) {
let refreshToken = new RefreshTokenItem(tokenResponse, this.clientId)
const key = refreshToken.tokenKey()
this.cache[key] = refreshToken.toString()
if (this.persistent) {
AsyncStorage.setItem(key, refreshToken.toString())
//.catch(err => { return err /* log error?*/ })
}
return refreshToken
}
removeToken(tokenKey) {
delete this.cache[tokenKey]
if (this.persistent) {
AsyncStorage.removeItem(tokenKey)
//.catch(err => { return err /* log error?*/ })
}
}
async getAccessToken(userId, scope) {
const key = BaseTokenItem.createAccessTokenKey(this.clientId, userId, scope)
if (this.cache[key]) {
return AccessTokenItem.fromJson(this.cache[key])
}
const accessTokenKeyPrefix = BaseTokenItem.createTokenKeyPrefix(this.clientId, userId)
for (const key of Object.getOwnPropertyNames(this.cache)) {
const scopeFormKey = BaseTokenItem.scopeFromKey(key)
if (scopeFormKey && key.startsWith(accessTokenKeyPrefix) && scope.isSubsetOf(scopeFormKey)) {
return AccessTokenItem.fromJson(this.cache[key])
}
}
if (this.persistent) {
let keys = await AsyncStorage.getAllKeys()
for (const key of keys) {
const scopeFormKey = BaseTokenItem.scopeFromKey(key)
if (scopeFormKey && key.startsWith(accessTokenKeyPrefix) && scope.isSubsetOf(scopeFormKey)) {
const token = await AsyncStorage.getItem(key)
this.cache[key] = token
return AccessTokenItem.fromJson(token)
}
}
}
return null
}
async getRefreshToken(userId) {
const key = BaseTokenItem.createRefreshTokenKey(this.clientId, userId)
let refreshToken = null
if (this.cache[key]) {
refreshToken = RefreshTokenItem.fromJson(this.cache[key])
}
if (this.persistent) {
const token = await AsyncStorage.getItem(key)
refreshToken = RefreshTokenItem.fromJson(token)
}
if ((this.cache[key] || this.persistent) && !refreshToken) {
// broken token was saved
this.removeToken(key)
}
return refreshToken
}
/**
* Return all tokens for the client ID the cache initialized with and
* given user ID. If userId omitted - for all users of current client ID
*
*/
async getAllUserTokenKeys(userId){
const tokenKeyPrefix = BaseTokenItem.createTokenKeyPrefix(this.clientId, userId)
console.info('getting tokens')
let tokenKeys = []
if (this.persistent) {
let keys = await AsyncStorage.getAllKeys()
for (const key of keys) {
if (key.startsWith(tokenKeyPrefix)) tokenKeys.push(key)
}
} else {
for (const key of Object.getOwnPropertyNames(this.cache)) {
if (key.startsWith(tokenKeyPrefix)) tokenKeys.push(key)
}
}
return tokenKeys
}
}
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 09 2025 13:24:03 GMT+0200 (Mitteleuropäische Sommerzeit) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>