auth

Documentation

Overview

Author: Paul Côté Last Change Author: Paul Côté Last Date Changed: 2022/06/10

Copyright (C) 2015-2018 Lightning Labs and The Lightning Network Developers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• func GetClientConn(grpcServerAddr, grpcServerPort, tlsCertPath, adminMacPath string, ...) (*grpc.ClientConn, error)
• func LoadMacaroon(pwCallback getPasswordFunc, macHex string) (*macaroon.Macaroon, error)
• func ReadPassword(text string) ([]byte, error)

Constants

const (
	ErrEmptyMac          = bg.Error("macaroon data is empty")
	ErrInvalidMacEncrypt = bg.Error("invalid encrypted macaroon. Format expected: 'snacl:<key_base64>:<encrypted_macaroon_base64>'")
)

Functions

func GetClientConn

func GetClientConn(grpcServerAddr, grpcServerPort, tlsCertPath, adminMacPath string, skipMacaroons bool, macaroon_timeout int64) (*grpc.ClientConn, error)

GetClientConn returns the grpc Client connection for use in instantiating gRPC Clients

func LoadMacaroon

func LoadMacaroon(pwCallback getPasswordFunc, macHex string) (*macaroon.Macaroon, error)

LoadMacaroon takes a password prompting function and hex encoded macaroon and returns an instantiated macaroon object

func ReadPassword

func ReadPassword(text string) ([]byte, error)

ReadPassword prompts the user for a password in the command line