Skip to content

ZacharyDavidSaunders/pseudoname

Repository files navigation

Pseudoname_API

Pseudoname License: MPL 2.0

What is "Pseudoname"?

At it's core, Pseudoname is a free, disposable email alias generating service. Pseudoname allows you to link your email address to custom aliases. These aliases can be used to sign up for online services and offer a layer of protection between the services and your private information.

Why use an alias?

Users tend to use common credentials between sites, despite warnings from cybersecurity professionals, and this may lead to disastrous consequences; should a single one of an individual’s accounts become compromised via a data breach, every other account belonging to the individual instantly becomes accessible to the public as well. Using a unique password for each user account certainly adds protection, as the credentials for one account are no longer valid for another, however, that still leaves a single point of failure, the email address associated with the accounts. Simply put, this problem, the usage of one email address across several user accounts, is the issue that aliases solve.

When users create aliases with Pseudoname, they are able to treat email addresses like burner phones, use them for as long as they are secure, and then delete them when they are exposed online.

How do I receive emails destined to my aliases?

Simply check the email associated with the aliases. Upon creation, each alias is linked to an email address. When Pseudoname receives an email destined to an alias, it automatically forwards it off to the associated email address.

How many aliases can I have?

As many as you want. However, you may not register an alias already in use by you, or another user.

How do I delete an alias?

Go to the Pseudoname site, enter the alias, and corresponding email, and press delete.

Can someone else delete my aliases?

No. In order to delete an alias, both the alias and associated email are required. Without these two pieces of information (which only you have), email deletion requests are refused.

Is this service secure? Can I trust you with my emails?

Yes, the service is secure. Pseudoname never gets access to your emails. We couldn't read them even if we wanted to — and we don't. Your emails are your business.

What is "PseudonameAPI"?

PseudonameAPI is the backend service that runs the Pseudoname site. It too is open source and more information about it can be found here!

PseudonameAPI Diagram

Pull Requests / Contributions

Pull requests are welcome and will be reviewed and merged in a case-by-case basis. If a Pull Request is urgent, please send an email to contactus@pseudoname.io

To-Do's

  • Add an edit alias feature.
  • Send a confirmation email upon alias creation. This will likely require an additional API call.

Release Notes

You'll find information about each release below.

Version 2.4

  • Updated client to support PseudonameAPI version 1.4 (see issue #10).
    • Updated API method usage.
    • Added rate-limiting support.
  • Removed CAPTCHA system as the API now contains a rate-limiting feature, making the CAPTCHA system obsolete.

Version 2.3

  • Added an rudimentary CAPTCHA system to address issue #9.

Version 2.2

  • Added "Copy Alias" button for convenience.
  • Added countdown timer on successful alias creation.
  • Changed Response HTML element to be a <div> instead of a <p>. — This also makes the spacing a little bit better and allows for the new elements (timer and button) to be added.
  • Fixed a typo in the "invalid alias" message.
  • Added emojis ... because that's what the kids are into now-a-days.

Version 2.1

  • Updated expected API responses.
  • Tweaked the how the status codes work.

Version 2.0 [Public Release]

  • Connected to PseudonameAPI.
  • Added links to repos.
  • Added / API call to wake up dyno quickly.

Version 1.0 [Beta]

  • Built the MVP version of the site. This version has the site directly communicate with ForwardMX and thus leaves the API key exposed. This version will soon be replaced with a more secure version that connects to PseudonameAPI. (When this migration occurs, the API key and all aliases will be purged, and users will be notified that the Beta has ended).

License

Mozilla Public License 2.0