scrt-link-core
Advanced tools
Core for scrt.link - a tool to securely share sensitive information online.
scrt.link lets you share sensitive information online. End-to-end encrypted. One time.
This package allows you to use the service programmatically. Use it whenever you need to share a secret.
yarn add scrt-link-core
The examples are based on the assumption that you use scrt.link as your backend - however, you may use this package with your own backend. Check the scrt-link repository for a reference implementation.
import { createSecret } from "scrt-link-core";
const { secretLink } = await createSecret("Some confidential information…");
// https://scrt.link/l/CWmbcLtxzFRad8JJ#ReCMTkJkAtUqFF9ydBAWdYaz
import { createSecret } from "scrt-link-core";
const { secretLink, alias, encryptionKey } = await createSecret("Some confidential information…", {
password: "some-passphrase",
secretType: "neogram", // "text" | "url" | "neogram"
neogramDestructionMessage: "This messages self-destructs in…"
neogramDestructionTimeout: 10;
}
});
/*
alias: CWmbcLtxzFRad8JJ
encryptionKey: ReCMTkJkAtUqFF9ydBAWdYaz
secretLink: https://scrt.link/l/CWmbcLtxzFRad8JJ#ReCMTkJkAtUqFF9ydBAWdYaz
/*
Find out about the various secret types and options on scrt.link - the website's code is open source and available here.
It's recommended to just use generated link. However, there is a helper function if you need a custom solution. The function expects the alias and the encryption key.
import { retrieveSecret } from "scrt-link-core";
const { message } = await retrieveSecret("CWmbcLtxzFRad8JJ", "ReCMTkJkAtUqFF9ydBAWdYaz")
});
// message: Some confidential information…
There are pre-built packages to use right away. I recommend Skypack, but you can find it on other CDNs like jsDelivr, cdnjs, unpkg.com.
<script type="module">
import { createSecret } from "https://cdn.skypack.dev/scrt-link-core";
// Use as described above…
createSecret("Some confidential information…").then(({ secretLink }) => {});
</script>
<html>
<head>
<!-- Load script via CDN -->
<script src="https://unpkg.com/scrt-link-core@latest/dist/esbuild/browser.js"></script>
</head>
<body>
<script>
// Functions are available on the window object
window
.createSecret("Some confidential information…")
.then(({ secretLink }) => {
console.log(`Success! Your secret link is: ${secretLink}`);
});
</script>
</body>
</html>
Boilerplate: https://github.com/metachris/typescript-boilerplate by Chris Hager
[0.2.1] - 2021-10-29
FAQs
Core for scrt.link - a tool to securely share sensitive information online.
The npm package scrt-link-core receives a total of 37 weekly downloads. As such, scrt-link-core popularity was classified as not popular.
We found that scrt-link-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.
Security News
FSF files an amicus brief against Neo4j, defending the AGPL and warning against adding restrictive terms that undermine free software rights.
Research
Security News
Malicious PyPI package ‘set-utils’ steals Ethereum private keys by exfiltrating them through blockchain transactions via the Polygon RPC.