atoponce

Documentation Standards

When creating documentation for your project, you should take advantage of some standards defined by the IETF for metasyntactic variables, domain names and IP addresses. Then, if people automatically copy and paste your examples, nothing harmful can (SHOULD!) happen.

Metasyntactic Variables

RFC 3092 was created on April 1 as a joke (as most RFCs created on that day are). However, there is sane logic to using standardized variables in code examples when documenting an open source project, or providing examples of how or how not to do some concept.

The variables are listed as follows:

• foo
• bar

atoponce

Cryptographic Best Practices

Putting cryptographic primitives together is a lot like putting a jigsaw puzzle together, where all the pieces are cut exactly the same way, but there is only one correct solution. Thankfully, there are some projects out there that are working hard to make sure developers are getting it right.

The following advice comes from years of research from leading security researchers, developers, and cryptographers. This Gist was [forked from Thomas Ptacek's Gist][1] to be more readable. Additions have been added from

atoponce

#!/usr/bin/python

import hashlib

nonce = 0
key = 'f3q4uszyt67cfatq'
pad = hashlib.sha256(str(nonce)+key).digest()

# encrypt
plaintext = 'the quick brown fox jumped over.'

atoponce

Uptime percentage: 99.91271

Account created 2015-12-12 12:00: http://ae7.st/s/w4tc6
  - 104,940 minutes from 2015-12-12 12:00 to 2016-02-23 09:00

Outages:
   240m: 2015-12-31 05:00 - 2015-12-31 09:00 (http://ae7.st/s/licq-)
   600m: 2015-12-31 23:00 - 2016-01-01 09:00 (http://ae7.st/s/ic9lh)
   600m: 2016-02-18 11:30 - 2016-02-18 21:30 (http://ae7.st/s/85hko)
  7720m: 2016-02-18 00:20 - 2016-02-23 09:00 (http://ae7.st/s/ifgl4)

atoponce

#!/bin/bash
HOME=/var/services/homes/backupchef
SNAPSHOT_DIR=$HOME/backups/myserver
LOG_DIR=$HOME/backups
KEY_ID=$HOME/.ssh/id_rsa
RM=/bin/rm;
MV=/bin/mv;
CP=/bin/cp;

$RM -rf $SNAPSHOT_DIR/daily.6;                                

atoponce

#!/bin/bash
HOME=/var/services/homes/backupchef
SNAPSHOT_DIR=$HOME/backups/myserver
LOG_DIR=$HOME/backups
KEY_ID=$HOME/.ssh/id_rsa
RM=/bin/rm;
MV=/bin/mv;
CP=/bin/cp;

$RM -rf $SNAPSHOT_DIR/daily.6;                                

atoponce

#!/bin/bash
HOME=/var/services/homes/backupchef
SNAPSHOT_DIR=$HOME/backups/myserver
LOG_DIR=$HOME/backups
KEY_ID=$HOME/.ssh/id_rsa
RM=/bin/rm;
MV=/bin/mv;
CP=/bin/cp;

$RM -rf $SNAPSHOT_DIR/daily.6;                                

atoponce

### Keybase proof

I hereby claim:

  * I am atoponce on github.
  * I am atoponce (https://keybase.io/atoponce) on keybase.
  * I have a public key whose fingerprint is E041 3539 273A 6534 A3E1  9259 22EE E048 8086 060F

To claim this, I am signing this object: