Security¶
Report a vulnerability¶
Please report a security problem privately first, through the contact form with the subject "Fadenstack security". Describe what you found and how to reproduce it. Do not open a public issue for it.
How Fadenstack handles data, encryption and access is described on the website's Security and privacy page.
When you build on Fadenstack¶
- Keep keys out of code. Read API keys from the environment or a secret store. A key acts with the rights of the user it belongs to.
- One key per use, and revoke what you don't need. Name each key after the app or script that uses it. Revoke a key in your profile when the app is retired or the key may have leaked; the server refuses it within a minute. Revoking needs a server 0.4.2 or later.
- Sign-ins end. A console sign-in ends on logout. A password change or reset, a suspension or a removed role ends all of the user's sign-ins. The gateway notices within 30 to 60 seconds and then answers 401
sign_in_ended. - Cookies and other sites. The console's own routes under
/apialso accept the console's sign-in cookie. A POST, PUT, PATCH or DELETE that carries that cookie and comes from another site's page (itsOriginorReferer) is refused with 403. Requests with anAuthorization: Bearerheader are not affected, so scripts and apps are not either. - Agents sign in per user and device. The SDKs keep an agent's sign-in for the user on that device. The user's password or login token is used once and not kept.
- Trust the server's certificate. A Fadenstack server often uses its own certificate authority. Install that CA where your application runs, or give it to the SDK, rather than turning certificate checks off.
- Classify your tools honestly. A tool that changes something is Write or Destructive, so the user is asked first. See Tools and approvals.
Links from the chat panels¶
The SDKs' chat panels have an About entry at the end of their settings, and a small Fadenstack link under the message box. A link to fadenstack.com carries two values and nothing else: ref, where the click came from (<refSource>-panel for the link under the message box, <refSource>-about for About), and v, the SDK's major.minor version, for example https://fadenstack.com/?ref=sdk-panel&v=0.2. Nothing about the user, the organisation, the server or the agent is in it, and links open with noopener noreferrer, so the browser sends no Referer either. The Help link goes to your own server. The server's address in About is shown, never sent.
- Name your app with
refSource: lower-case letters and digits, words joined by hyphens, at most 20 characters, such asmy-crm. Anything else falls back tosdk. Never put a customer's, tenant's or host's name in it. - Hide the link under the message box with
brandingoff. The AI notice and About stay.
AgentChatOptions.RefSource and AgentChatOptions.Branding. See About and the Fadenstack link.
The chat options refSource and branding, and openLink for a host that opens links its own way. See About and the Fadenstack link.
The console has the same links: About Fadenstack in its Help menu and the avatar menu, and a line on the sign-in page. They carry ref=console-… and, once you are signed in, the release's major.minor; nothing else.