Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

improved PID logic, added token lifetime support

Blue Mousefb8ea682c220
diff --git a/captcha-loader.js b/captcha-loader.js
index bcd994500..f15c3f6cf 100644
--- a/captcha-loader.js
+++ b/captcha-loader.js
@@ -1,174 +1,184 @@
-(() => {
- const CAPTCHA_SELECTOR = '.swecaptcha'
- const LIGHT_CAPTCHA_IFRAME_URL = './light.html'
- const DARK_CAPTCHA_IFRAME_URL = './dark.html'
- const DEFAULT_RESPONSE_INPUT_NAME = 'swetrix-captcha-response'
- const MESSAGE_IDENTIFIER = 'swetrix-captcha'
- const ID_PREFIX = 'swetrix-captcha-'
- const THEMES = ['light', 'dark']
-
- const ids = []
-
- const log = (status, text) => {
- console[status](`[Swetrix Captcha] ${text}`)
+const CAPTCHA_SELECTOR = '.swecaptcha'
+const LIGHT_CAPTCHA_IFRAME_URL = './light.html'
+const DARK_CAPTCHA_IFRAME_URL = './dark.html'
+const DEFAULT_RESPONSE_INPUT_NAME = 'swetrix-captcha-response'
+const MESSAGE_IDENTIFIER = 'swetrix-captcha'
+const ID_PREFIX = 'swetrix-captcha-'
+const THEMES = ['light', 'dark']
+const PID_REGEX = /^(?!.*--)[a-zA-Z0-9-]{12}$/
+
+const isValidPID = (pid) => PID_REGEX.test(pid)
+
+const ids = []
+
+const log = (status, text) => {
+ console[status](`[Swetrix Captcha] ${text}`)
+}
+
+const appendParamsToURL = (url, params) => {
+ const queryString = Object.keys(params).map((key) => {
+ return `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`
+ }).join('&')
+
+ return `${url}?${queryString}`
+}
+
+const renderCaptcha = (container, params) => {
+ const cid = generateRandomID()
+ const cParams = {
+ ...params,
+ cid, // CAPTCHA ID
}
- const appendParamsToURL = (url, params) => {
- const queryString = Object.keys(params).map((key) => {
- return `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`
- }).join('&')
-
- return `${url}?${queryString}`
- }
+ const frame = generateCaptchaFrame(cParams)
+ const input = generateHiddenInput(cParams)
- const renderCaptcha = (container, params) => {
- const cid = generateRandomID()
- const cParams = {
- ...params,
- cid, // CAPTCHA ID
- }
+ container.appendChild(frame)
+ container.appendChild(input)
+}
- const frame = generateCaptchaFrame(cParams)
- const input = generateHiddenInput(cParams)
+const generateRandomID = () => {
+ const randomID = ID_PREFIX + Math.random().toString(36).substr(2, 6)
- container.appendChild(frame)
- container.appendChild(input)
+ if (ids.includes(randomID)) {
+ return generateRandomID()
}
- const generateRandomID = () => {
- const randomID = ID_PREFIX + Math.random().toString(36).substr(2, 6)
+ ids.push(randomID)
- if (ids.includes(randomID)) {
- return generateRandomID()
- }
+ return randomID
+}
- ids.push(randomID)
+const postMessageCallback = (pmEvent) => {
+ // TODO: Validate origin
- return randomID
- }
+ const { data } = pmEvent
- const postMessageCallback = (pmEvent) => {
- // TODO: Validate origin
+ if (!data) {
+ return
+ }
- const { data } = pmEvent
+ const {
+ type, cid, event,
+ } = data
- if (!data) {
- return
- }
+ if (type !== MESSAGE_IDENTIFIER) {
+ return
+ }
- const {
- type, cid, event,
- } = data
+ if (!cid || !ids.includes(cid)) {
+ return
+ }
- if (type !== MESSAGE_IDENTIFIER) {
- return
- }
+ const input = document.getElementById(cid)
+ const inputExists = input !== null
- if (!cid || !ids.includes(cid)) {
- return
- }
+ switch (event) {
+ case 'success':
+ const { token } = data
- const input = document.getElementById(cid)
- const inputExists = input !== null
+ if (!inputExists) {
+ log('error', '[PM -> success] Input element does not exist.')
+ return
+ }
- switch (event) {
- case 'success':
- const { token } = data
+ input.value = token
- if (!inputExists) {
- log('error', '[PM -> success] Input element does not exist.')
- return
- }
+ break
- input.value = token
+ case 'failure':
+ if (!inputExists) {
+ log('error', '[PM -> failure] Input element does not exist.')
+ return
+ }
- break
+ input.value = ''
- case 'failure':
- if (!inputExists) {
- log('error', '[PM -> failure] Input element does not exist.')
- return
- }
+ break
- input.value = ''
+ case 'tokenExpired':
+ if (!inputExists) {
+ log('error', '[PM -> failure] Input element does not exist.')
+ return
+ }
- break
+ input.value = ''
- case 'tokenExpired':
- // TODO
- break
- }
+ break
}
+}
+
+const generateCaptchaFrame = (params) => {
+ const { theme } = params
+ const captchaFrame = document.createElement('iframe')
+
+ captchaFrame.src = theme === 'dark'
+ ? appendParamsToURL(DARK_CAPTCHA_IFRAME_URL, params)
+ : appendParamsToURL(LIGHT_CAPTCHA_IFRAME_URL, params)
+ captchaFrame.title = 'Swetrix Captcha'
+ captchaFrame.style.border = 'none'
+ captchaFrame.style.width = '302px'
+ captchaFrame.style.height = 'auto'
+ captchaFrame.style.overflow = 'visible'
+
+ return captchaFrame
+}
+
+const generateHiddenInput = (params) => {
+ const { cid } = params
+ const input = document.createElement('input')
+
+ input.type = 'hidden'
+ input.name = params.respName,
+ input.value = ''
+ input.id = cid
- const generateCaptchaFrame = (params) => {
- const { theme } = params
- const captchaFrame = document.createElement('iframe')
+ return input
+}
- captchaFrame.src = theme === 'dark'
- ? appendParamsToURL(DARK_CAPTCHA_IFRAME_URL, params)
- : appendParamsToURL(LIGHT_CAPTCHA_IFRAME_URL, params)
- captchaFrame.title = 'Swetrix Captcha'
- captchaFrame.style.border = 'none'
- captchaFrame.style.width = '302px'
- captchaFrame.style.height = 'auto'
- captchaFrame.style.overflow = 'visible'
+const validateParams = (params) => {
+ const { theme, pid } = params
- return captchaFrame
+ if (theme && !THEMES.includes(theme)) {
+ log('error', `Invalid data-theme parameter: ${theme}`)
+ return false
}
- const generateHiddenInput = (params) => {
- const { cid } = params
- const input = document.createElement('input')
-
- input.type = 'hidden'
- input.name = params.respName,
- input.value = ''
- input.id = cid
-
- return input
+ if (!pid || !isValidPID(pid)) {
+ log('error', `Invalid data-project-id parameter: ${pid}`)
+ return false
}
- const validateParams = (params) => {
- const { theme } = params
-
- if (theme && !THEMES.includes(theme)) {
- log('error', `Invalid data-theme parameter: ${theme}`)
- return false
- }
+ return true
+}
- // TODO: Validate pid via regex
+const parseParams = (container) => ({
+ pid: container.getAttribute('data-project-id'),
+ respName: container.getAttribute('data-response-input-name') || DEFAULT_RESPONSE_INPUT_NAME,
+ theme: container.getAttribute('data-theme'),
+})
- return true
+const main = () => {
+ if ('swecaptcha' in window) {
+ log('warn', 'Captcha is already loaded.')
}
- const parseParams = (container) => ({
- pid: container.getAttribute('data-project-id'),
- respName: container.getAttribute('data-response-input-name') || DEFAULT_RESPONSE_INPUT_NAME,
- theme: container.getAttribute('data-theme'),
- })
-
- const main = () => {
- // TODO: Add some callbacks here
- window.swecaptcha = true
- window.addEventListener('message', postMessageCallback)
-
- const containers = document.querySelectorAll(CAPTCHA_SELECTOR)
+ // TODO: Add some callbacks here
+ window.swecaptcha = true
+ window.addEventListener('message', postMessageCallback)
- for (const container of containers) {
- const params = parseParams(container)
+ const containers = document.querySelectorAll(CAPTCHA_SELECTOR)
- if (!validateParams(params)) {
- log('error', 'Aborting captcha rendering due to invalid parameters.')
- return
- }
+ for (const container of containers) {
+ const params = parseParams(container)
- renderCaptcha(container, params)
+ if (!validateParams(params)) {
+ log('error', 'Aborting captcha rendering due to invalid parameters.')
+ return
}
- }
- if ('swecaptcha' in window) {
- log('warn', 'Captcha is already loaded.')
+ renderCaptcha(container, params)
}
+}
- document.addEventListener('DOMContentLoaded', main)
-})()
+document.addEventListener('DOMContentLoaded', main)
diff --git a/captcha.js b/captcha.js
index 627a8fe58..f0f568349 100644
--- a/captcha.js
+++ b/captcha.js
@@ -1,6 +1,7 @@
const API_URL = 'http://localhost:5005/v1/captcha'
const MESSAGE_IDENTIFIER = 'swetrix-captcha'
const DEFAULT_THEME = 'light'
+const CAPTCHA_TOKEN_LIFETIME = 300 // seconds (5 minutes).
let TOKEN = ''
let HASH = ''
@@ -63,6 +64,13 @@ const activateAction = (action) => {
actions[action].classList.remove('hidden')
}
+const setLifetimeTimeout = () => {
+ setTimeout(() => {
+ postMessage(IFRAME_MESSAGE_TYPES.TOKEN_EXPIRED)
+ activateAction('checkbox')
+ }, CAPTCHA_TOKEN_LIFETIME * 1000)
+}
+
const enableManualChallenge = (svg) => {
const manualChallenge = document.querySelector('#manual-challenge')
const svgCaptcha = document.querySelector('#svg-captcha')
@@ -200,6 +208,7 @@ document.addEventListener('DOMContentLoaded', () => {
svgCaptchaInput.value = ''
postMessage(IFRAME_MESSAGE_TYPES.SUCCESS, { token })
+ setLifetimeTimeout()
activateAction('completed')
disableManualChallenge()
})
@@ -225,6 +234,7 @@ document.addEventListener('DOMContentLoaded', () => {
TOKEN = token
postMessage(IFRAME_MESSAGE_TYPES.SUCCESS, { token })
+ setLifetimeTimeout()
activateAction('completed')
return
} catch (e) {
diff --git a/test.html b/test.html
index d954cc699..f02788eaf 100644
--- a/test.html
+++ b/test.html
@@ -25,7 +25,7 @@
<input type="text" name="name" value="name">
<input type="text" name="email" value="email">
<input type="number" name="number" value="number">
- <div class="swecaptcha" data-project-id="testtest" data-theme="light"></div>
+ <div class="swecaptcha" data-project-id="v0siIpVYWxhk" data-theme="light"></div>
<input type="submit" value="Submit">
</form>
</body>