mylogin

package module

v1.1.0 Latest Latest Go to latest Published: Apr 2, 2023 License: Apache-2.0 Imports: 11 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dolmen-go/mylogin

Links

Open Source Insights

README ¶

mylogin - Go utilities for reading MySQL credentials from `~/.mylogin.cnf`

About mylogin.cnf:

Go package

github.com/dolmen-go/mylogin Library for reading and writing ~/.mylogin.cnf.

Utilities

`mylogin`: dump `~/.mylogin.cnf` content in clear

go get -u github.com/dolmen-go/cmd/mylogin
mylogin -h

`mylogin-dsn`: dump a `mylogin.cnf` section as a `go-sql-driver/mysql` connection string prefix

go get -u github.com/dolmen-go/cmd/mylogin-dsn
mylogin-dsn -h

License

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.

Documentation ¶

Rendered for

Overview ¶

Package mylogin reads and writes ~/.mylogin.cnf created by mysql_config_editor.

Reference documentation:

Example:

mysql_config_editor set --login-path=foo --user=bar -p

For usage examples, see the utilies in the same repo.

Index ¶

Constants
func DefaultFile() string
func Encode(w io.Writer, f File) (err error)
func FilterSection(rd io.Reader, section string) io.Reader
type File
- func Decode(input io.Reader) (File, error)
type Key
- func NewKey(readRandom func([]byte) (int, error)) (Key, error)
- func (k Key) IsZero() bool
type Login
- func ReadLogin(filename string, sectionNames []string) (login *Login, err error)
type Section
type Sections
- func Parse(rd io.Reader) (sections Sections, err error)
- func ReadSections(filename string) (sections Sections, err error)
- func (sections Sections) Login(section string) *Login
- func (sections Sections) Merge(sectionNames []string) (login *Login)

Constants ¶

View Source

const DefaultSection = "client"

DefaultSection is the name of the base section used by all MySQL client tools.

Variables ¶

This section is empty.

Functions ¶

func DefaultFile ¶

func DefaultFile() string

DefaultFile returns the path to the default mylogin.cnf file:

Windows: %APPDATA%/MySQL/.mylogin.cnf
others: ~/.mylogin.cnf

If the environment variable MYSQL_TEST_LOGIN_FILE is set that path is returned instead.

func Encode ¶

func Encode(w io.Writer, f File) (err error)

Encode writes a mylogin.cnf content encrypted

func FilterSection(rd io.Reader, section string) io.Reader

FilterSection reads an INI-style content and filter out any section except the given one

Types ¶

type File ¶

type File interface {
	// The key used for encrypting the file
	Key() Key
	// Byte ordering for saving int32 chunk sizes
	ByteOrder() binary.ByteOrder
	// The plaintext content of the file
	PlainText() io.Reader
}

File is the full structure of a mylogin.cnf file.

func Decode ¶

func Decode(input io.Reader) (File, error)

Decode is a filter that returns the plaintext content of a mylogin.cnf file. The file is encrypted with AES 128 CBC with the key embedded in the file.

type Key ¶

type Key [20]byte

Key is a key used for encryption of mylogin.cnf files.

func NewKey ¶

func NewKey(readRandom func([]byte) (int, error)) (Key, error)

NewKey creates a new key from a source of random bytes. See math/rand.Read and crypto/rand.Read as possible sources.

The generated key has the 3 high bits cleared so each byte is non-printable.

func (Key) IsZero ¶

func (k Key) IsZero() bool

type Login struct {
	User     *string `json:"user,omitempty"`
	Password *string `json:"password,omitempty"`
	Host     *string `json:"host,omitempty"`   // TCP hostname
	Port     *string `json:"port,omitempty"`   // TCP port
	Socket   *string `json:"socket,omitempty"` // Unix socket path
}

Login is the content of a section of mylogin.cnf.

func ReadLogin ¶

func ReadLogin(filename string, sectionNames []string) (login *Login, err error)

ReadLogin reads a mylogin.cnf file, extracts the requested sections and merges them to obtain a single Login (that may be empty).

func (l *Login) DSN() string

DSN builds a DSN for github.com/go-sql-driver/mysql

The DSN returned always has a '/' at the end. The DSN for an empty Login is just "/".

func (l *Login) IsEmpty() bool

IsEmpty is true if l is nil or none of the fields are set.

func (l *Login) Merge(other *Login)

Merge merges l into login: options set in l take precedence over options set in login.

func (l *Login) String() string

String returns DSN().

type Section ¶

type Section struct {
	Name  string `json:"name"`
	Login Login  `json:"login"`
}

Section represents one section of the plaintext content of mylogin.cnf.

type Sections ¶

type Sections []Section

Sections represents the structured content on the plaintext of mylogin.cnf.

func Parse ¶

func Parse(rd io.Reader) (sections Sections, err error)

Parse parses the plaintext content of a mylogin.cnf file and returns the structured content.

func ReadSections ¶

func ReadSections(filename string) (sections Sections, err error)

ReadSections reads all Sections of a mylogin.cnf file.

func (sections Sections) Login(section string) *Login

Login returns the Login from the section with the given name.

func (Sections) Merge ¶

func (sections Sections) Merge(sectionNames []string) (login *Login)

Merge returns a single Login which is the result of the ordered merge of the section with the given names (see Login.Merge). For each option the last section that has a value has the precedence.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
mylogin command Command mylogin allows to dump the content of ~/.my.cnf.	Command mylogin allows to dump the content of ~/.my.cnf.
mylogin-dsn command
mylogin-key command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

mylogin

README ¶

mylogin - Go utilities for reading MySQL credentials from `~/.mylogin.cnf`

Go package

Utilities

`mylogin`: dump `~/.mylogin.cnf` content in clear

`mylogin-dsn`: dump a `mylogin.cnf` section as a `go-sql-driver/mysql` connection string prefix

See also

License

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func DefaultFile ¶

func Encode ¶

func FilterSection ¶

Types ¶

type File ¶

func Decode ¶

type Key ¶

func NewKey ¶

func (Key) IsZero ¶

func ReadLogin ¶

type Section ¶

type Sections ¶

func Parse ¶

func ReadSections ¶

func (Sections) Merge ¶

Source Files ¶

Directories ¶

README ¶

mylogin - Go utilities for reading MySQL credentials from ~/.mylogin.cnf

Go package

Utilities

mylogin: dump ~/.mylogin.cnf content in clear

mylogin-dsn: dump a mylogin.cnf section as a go-sql-driver/mysql connection string prefix

See also

License

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func DefaultFile ¶

func Encode ¶

func FilterSection ¶

Types ¶

type File ¶

func Decode ¶

type Key ¶

func NewKey ¶

func (Key) IsZero ¶

type Login ¶

func ReadLogin ¶

func (*Login) DSN ¶

func (*Login) IsEmpty ¶

func (*Login) Merge ¶

func (*Login) String ¶

type Section ¶

type Sections ¶

func Parse ¶

func ReadSections ¶

func (Sections) Login ¶

func (Sections) Merge ¶

Source Files ¶

Directories ¶

mylogin - Go utilities for reading MySQL credentials from `~/.mylogin.cnf`

`mylogin`: dump `~/.mylogin.cnf` content in clear

`mylogin-dsn`: dump a `mylogin.cnf` section as a `go-sql-driver/mysql` connection string prefix