IPython extension to mask sensitive data

Simple ipython extension to mask the username or other sensitive data from notebook cell outputs. This may be useful when printing or display sensitive information in public notebooks. The extension modifies the ipython display system to mask any occurence of one of the secrets strings in the textual outputs from printing, logging and the native display system.

Usage

To load the extension use the magic command %load_ext nbmask. The extension will automatically mask the notebook display textual outputs without any further magic commands. By default the extension will mask the username.

import os
from pathlib import Path

%load_ext nbmask

username = os.getenv('USER')
print("My name is {username}!")
# >>> My name is ...!

documents = Path(f"~/Documents").expanduser()
documents
# >>> PosixPath('/Users/.../Documents')

You can add more secrets with the %nbmask magic line command and pass it any string parameter with the $name variable notation.

TOKEN = my_secret_token()

%nbmask "$TOKEN"

credentials = dict(user=username, token=TOKEN)

credentials
# >>> {'user': '...', 'token': '...'}

The extension applies to standard output, standard error and also the default logging handlers.

import logging

logging.basicConfig(level="DEBUG")

logging.debug("Token is %s", TOKEN)
# >>> DEBUG:root:Token is ...

To mask print or pprint outputs the extension still includes a %%masked cell magic, but it is no longer needed and it will be removed.

Example

See nbmask-tests.ipynb in extras

Installation

You can install the current version of this package with pip

pip install nbmask

Changelog

0.0.4

• Cell magic %%masked is no longer needed. Will be removed

0.0.3

• Masking pattern is cached