cmd

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Brennan Jackson btj9560@rit.edu

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2021 Brennan Jackson btj9560@rit.edu

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func DecryptJournal(encryptedJournal []byte, passPhrase string) ([]byte, error)
• func DisplayOutputInEditor(plaintextJournal []byte)
• func EncryptJournal(journalBytes []byte, passPhrase string) ([]byte, error)
• func Execute()
• func GetEditorInput() ([]byte, error)
• type EditorResolver

Constants

const DefaultEditor = "vim"

* * Default values

const FileExtension = ".ck"

Variables

var DefaultFileName string = time.Now().Format("2006-01-02_1504")

Functions

func DecryptJournal

func DecryptJournal(encryptedJournal []byte, passPhrase string) ([]byte, error)

* * Decrypt journal entry * TODO: Refactor for use beyond testing

func DisplayOutputInEditor

func DisplayOutputInEditor(plaintextJournal []byte)

* * Displays decrypted plain text journal in user prefered editor

func EncryptJournal

func EncryptJournal(journalBytes []byte, passPhrase string) ([]byte, error)

* * Encrypts the journal contents. Uses the usrs passphrase to generate hash.

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GetEditorInput

func GetEditorInput() ([]byte, error)

* * Create a temporary file in a temp directory and open it in the users preffered editor. * Delete the temp file once we read in the contents of it

Types

type EditorResolver

type EditorResolver func() string

EditorResolver returns the editor to use based on user preferrence or default