mushpup : MushpupNotation

Wiki source for MushpupNotation


Show raw source

=====Mushpup Notation=====
Mushpup notation is inspired by standard [[http://en.wikipedia.org/wiki/Security_protocol_notation | security protocol notation]] but seeks to simplify it for ordinary users. The basic syntax:

""<tt style="font-weight:bold; color:blue;">m{site > msw}side<tt>""

where:
- **m{}** signifies use of the Mushpup algorthim on the variables inside the brackets -- this is constant
- **site** is the value of site entered in the form
- **msw** stands for Mushpup secret word -- this is constant (i.e., for security, this should not be replaced with the actual word but always read **msw** or be left out all together)*
- **side** indicates the side of the hash from which the password will be copied and its length. l8, for instance, would stand for left 8 characters

* Note: if you had more than one Mushpup Secret Word, you could signify that here by indication, for example, **msw1** or **msw2**.

===An Example===

""<tt style="font-weight:bold; color:blue;">m{mushpup.org/MushPup > msw}r8</tt>""

What this means:
- the first 'm' simply signifies the info within the brackets will be encrypted (hashed) using the ordinary (v.1) mushpup algorithm.
- within the brackets there are two variables separated by the **>**: **mushpup.org/MushPup** and **msw**
- mushpup.org/MushPup (left of the **>**): this is the site value -- this doesn't need to be secret
- msw (right of the **>**): this signifies you mushpup secret word. Again, this is redundant.
- r8: indicates that you are going to be using the 8 characters at the right end of the produced mushpup hash -- l means from left, r means from right, and m means middle (as in **m8**, middle 8 characters of hash)

===A Version 2 Example===

""<tt style="font-weight:bold; color:blue;">m{mushpup.org/MushPup/*}r8</tt>""

The basic notation is the same with version 2. The ""<b>*</b>"" is added to indicate the [[MushpupModifiers | modifier]] for including alpha, numeric, and special characters is used.

===Recommended Notation===
Since you are probably going to know the user name you are using to sign in any way, you don't really need to include that. And if you are consistent in using the domain-dot-tld format in your site string, you don't really need to use that either. Similarly with the side value. So for most cases, you can just use the following format:

""<tt style="font-weight:bold; color:blue;">m{site/domain/%modifier(s)%}</tt>""

Example for password requiring [[MushpupModifiers | modifier]] for alpha, numeric, and special characters:
""<tt style="font-weight:bold; color:blue;">m{mushpup.org/MushPup/*}</tt>""