Подписанная идентификация
Обычный вызов uj.identify отправляется из браузера, поэтому его может изменить кто угодно. Подписанная идентификация предотвращает подмену: ваш сервер подписывает краткоживущий JWT с алгоритмом HS256, подтверждающий личность пользователя, а виджет передает этот токен в UserJot.
Все данные в токене (ID пользователя, адрес электронной почты, имя, аватар, атрибуты и компании) считаются проверенными.
Когда это нужно
Вы хотите проверять, что отзывы, голоса и беседы поступают от настоящей учетной записи пользователя, вошедшего в систему.
Вы хотите, чтобы клиенты могли редактировать и удалять собственные публикации с отзывами и комментарии в виджете (сеансы без подписи
uj.identifyне могут редактировать и удалять содержимое виджета).Вы включили параметр Требовать токены с подписью в разделе Настройки → Вход (доступен в тарифных планах Starter и Professional после включения параметра Автоматический вход). Этот параметр отклоняет неподписанные вызовы идентификации и требует также включать данные о членстве в компаниях в подписанный токен (неподписанные данные на стороне клиента
companiesигнорируются с предупреждениемUNSIGNED_COMPANY_IGNORED).Виджетом пользуется администратор или владелец рабочего пространства. Идентификация без подписи для привилегированных учетных записей никогда не принимается. Подписанный токен применяет их атрибуты и компании; имя, аватар и адрес электронной почты по-прежнему управляются в панели управления, а если они переданы в запросе, возвращается предупреждение
PRIVILEGED_PROFILE_IGNORED.
Если в вашем продукте используются и веб-виджет, и Swift SDK, включение параметра Require signed tokens обеспечивает проверку в обоих случаях. Веб-виджет использует JWT с алгоритмом HS256 (token), а Swift SDK — HMAC-SHA256 signature, подписанный тем же секретом рабочего пространства.
1. Создайте токен на своём сервере
Подпишите JWT с помощью HS256, используя секрет рабочего пространства. Значения Project ID и Project secret находятся в разделе Settings → Login, в подразделе Secrets.
Никогда не подписывайте токены в браузере. Храните секрет на своем сервере.
Обязательные утверждения
Утверждение | Значение |
|---|---|
| Неизменяемый ID пользователя в вашей системе. Обязательно. |
| ID вашего проекта UserJot. Обязательно. |
| Точная строка |
| Время выпуска в формате Unix, в секундах. Обязательно. |
| Время истечения срока действия в формате Unix, в секундах. Обязательно. Не более чем через 1 час ( |
Дополнительные проверяемые утверждения
Вы также можете включить email, firstName, lastName, avatar, traits и companies. Каждая запись в companies поддерживает:
{
"companies": [
{
"id": "acme",
"name": "ACME Inc.",
"domain": "acme.com",
"logo": "https://acme.com/logo.png",
"traits": { "plan": "enterprise" }
}
]
}Примеры для серверов
Node.js
import jwt from 'jsonwebtoken';
export function createUserJotToken(user, secret, projectId) {
return jwt.sign(
{
sub: user.id,
email: user.email,
firstName: user.firstName,
lastName: user.lastName,
iss: projectId,
aud: 'userjot'
},
secret,
{ algorithm: 'HS256', expiresIn: '1h' }
);
}Python
import time
import jwt
def create_userjot_token(user, secret, project_id):
now = int(time.time())
return jwt.encode(
{
"sub": user["id"],
"email": user["email"],
"firstName": user["first_name"],
"lastName": user["last_name"],
"iss": project_id,
"aud": "userjot",
"iat": now,
"exp": now + 3600,
},
secret,
algorithm="HS256",
)PHP
<?php
use Firebase\JWT\JWT;
function createUserJotToken(array $user, string $secret, string $projectId): string
{
$now = time();
return JWT::encode([
'sub' => $user['id'],
'email' => $user['email'],
'firstName' => $user['firstName'],
'lastName' => $user['lastName'],
'iss' => $projectId,
'aud' => 'userjot',
'iat' => $now,
'exp' => $now + 3600,
], $secret, 'HS256');
}Ruby
require 'jwt'
def create_userjot_token(user, secret, project_id)
now = Time.now.to_i
payload = {
sub: user[:id],
email: user[:email],
firstName: user[:first_name],
lastName: user[:last_name],
iss: project_id,
aud: 'userjot',
iat: now,
exp: now + 3600
}
JWT.encode(payload, secret, 'HS256')
endВыпускайте новый токен при каждой загрузке страницы или через аутентифицированную конечную точку бэкенда. Срок действия токенов истекает не позднее чем через 1 час, поэтому не кэшируйте их дольше.
2. Передайте токен для идентификации
Передайте JWT в поле token:
uj.identify({
token: 'TOKEN_FROM_YOUR_SERVER'
});Для передачи дополнительных непроверенных полей можно также передать user и companies вместе с token. Если поле указано в обоих местах, приоритет имеет подписанный токен (если не включен параметр Требовать токены с подписью, при котором данные о компаниях без подписи игнорируются). Убедитесь, что проверка выполнена, с помощью возвращенного промиса:
const result = await uj.identify({ token });
result.identityTrust; // 'signed'Недействительные токены приводят к ошибке, а не к переходу на запасной вариант
Если срок действия токена истек, его формат неверен или он подписан неправильным секретом, uj.identify отклоняет запрос с ошибкой IDENTIFY_FAILED, а не выполняет незаметный переход к неподписанному сеансу.
Подписанная идентификация и переписки
Если анонимный посетитель начинает гостевую беседу, а затем идентифицируется с помощью подписанного токена, его гостевая беседа переносится в проверенную учетную запись участника.
Беседы, начатые с подтвержденной идентификацией, остаются защищенными. При повторном открытии без подписанного сеанса посетителю предлагается пройти проверку, прежде чем просматривать историю.
Включение параметра Require signed tokens по-прежнему позволяет анонимным посетителям начинать гостевые беседы в рамках браузера; оно только не позволяет неподписанным вызовам
identifyпривязываться к учетным записям участников.
Идентификация сохраняется при переходе на общедоступные страницы
После идентификации виджет автоматически передает сеанс ссылкам на ваши общедоступные страницы UserJot (доску, дорожную карту, журнал изменений или справочный центр). Чтобы посетители открывали эти страницы уже вошедшими в систему, включите Automatic login в разделе Settings → Login (тариф Starter или Professional). См. раздел Automatic login.
Устранение неполадок
Вызов identify отклоняется с ошибкой IDENTIFY_FAILED
Убедитесь, что токен подписан с помощью HS256 и текущего значения Project secret.
Убедитесь, что
issсоответствует вашему Project ID, аaudв точности равноuserjot.Убедитесь, что указаны и
iat, иexpв формате Unix, в секундах, и чтоexp - iat <= 3600.Убедитесь, что часы сервера показывают точное время (токены, выпущенные в будущем, отклоняются, если расхождение превышает 60 секунд).
Идентификация без подписи перестала работать
Параметр Require signed tokens включен в разделе Settings → Login (отображается, когда включен Automatic login). После включения каждый вызов identify должен содержать действительный подписанный token.