Back to godoc.org

Package identity

v0.0.0-...-c738852
Latest Go to latest

The highest tagged major version is .

Published: Oct 4, 2020 | License: GPL3 | Module: github.com/MichaelMure/git-bug

Overview

Package identity contains the identity data model and low-level related functions

Index

Variables

var ErrIdentityNotExist = errors.New("identity doesn't exist")
var ErrMultipleIdentitiesSet = errors.New("multiple user identities set")
var ErrNoIdentitySet = errors.New("No identity is set.\n" +
	"To interact with bugs, an identity first needs to be created using " +
	"\"git bug user create\"")
var ErrNonFastForwardMerge = errors.New("non fast-forward identity merge")

func Fetch

func Fetch(repo repository.Repo, remote string) (string, error)

Fetch retrieve updates from a remote This does not change the local identities state

func GetUserIdentityId

func GetUserIdentityId(repo repository.Repo) (entity.Id, error)

func IsUserIdentitySet

func IsUserIdentitySet(repo repository.Repo) (bool, error)

IsUserIdentitySet say if the user has set his identity

func MergeAll

func MergeAll(repo repository.ClockedRepo, remote string) <-chan entity.MergeResult

MergeAll will merge all the available remote identity

func NewErrMultipleMatch

func NewErrMultipleMatch(matching []entity.Id) *entity.ErrMultipleMatch

func Pull

func Pull(repo repository.ClockedRepo, remote string) error

Pull will do a Fetch + MergeAll This function will return an error if a merge fail

func Push

func Push(repo repository.Repo, remote string) (string, error)

Push update a remote with the local changes

func ReadAllLocal

func ReadAllLocal(repo repository.ClockedRepo) <-chan StreamedIdentity

ReadAllLocal read and parse all local Identity

func ReadAllRemote

func ReadAllRemote(repo repository.ClockedRepo, remote string) <-chan StreamedIdentity

ReadAllRemote read and parse all remote Identity for a given remote

func SetUserIdentity

func SetUserIdentity(repo repository.RepoConfig, identity *Identity) error

SetUserIdentity store the user identity's id in the git config

type Identity

type Identity struct {
	// contains filtered or unexported fields
}

func GetUserIdentity

func GetUserIdentity(repo repository.Repo) (*Identity, error)

GetUserIdentity read the current user identity, set with a git config entry

func NewFromGitUser

func NewFromGitUser(repo repository.Repo) (*Identity, error)

NewFromGitUser will query the repository for user detail and build the corresponding Identity

func NewIdentity

func NewIdentity(name string, email string) *Identity

func NewIdentityFull

func NewIdentityFull(name string, email string, login string, avatarUrl string) *Identity

func ReadLocal

func ReadLocal(repo repository.Repo, id entity.Id) (*Identity, error)

ReadLocal load a local Identity from the identities data available in git

func ReadRemote

func ReadRemote(repo repository.Repo, remote string, id string) (*Identity, error)

ReadRemote load a remote Identity from the identities data available in git

func (*Identity) AvatarUrl

func (i *Identity) AvatarUrl() string

AvatarUrl return the last version of the Avatar URL

func (*Identity) Commit

func (i *Identity) Commit(repo repository.ClockedRepo) error

Write the identity into the Repository. In particular, this ensure that the Id is properly set.

func (*Identity) CommitAsNeeded

func (i *Identity) CommitAsNeeded(repo repository.ClockedRepo) error

func (*Identity) DisplayName

func (i *Identity) DisplayName() string

DisplayName return a non-empty string to display, representing the identity, based on the non-empty values.

func (*Identity) Email

func (i *Identity) Email() string

Email return the last version of the email

func (*Identity) Id

func (i *Identity) Id() entity.Id

Id return the Identity identifier

func (*Identity) ImmutableMetadata

func (i *Identity) ImmutableMetadata() map[string]string

ImmutableMetadata return all metadata for this Identity, accumulated from each Version. If multiple value are found, the first defined takes precedence.

func (*Identity) IsProtected

func (i *Identity) IsProtected() bool

IsProtected return true if the chain of git commits started to be signed. If that's the case, only signed commit with a valid key for this identity can be added.

func (*Identity) Keys

func (i *Identity) Keys() []*Key

Keys return the last version of the valid keys

func (*Identity) LastModification

func (i *Identity) LastModification() timestamp.Timestamp

LastModification return the timestamp at which the last version of the identity became valid.

func (*Identity) LastModificationLamport

func (i *Identity) LastModificationLamport() lamport.Time

LastModificationLamportTime return the Lamport time at which the last version of the identity became valid.

func (*Identity) Login

func (i *Identity) Login() string

Login return the last version of the login

func (*Identity) MarshalJSON

func (i *Identity) MarshalJSON() ([]byte, error)

MarshalJSON will only serialize the id

func (*Identity) Merge

func (i *Identity) Merge(repo repository.Repo, other *Identity) (bool, error)

Merge will merge a different version of the same Identity

To make sure that an Identity history can't be altered, a strict fast-forward only policy is applied here. As an Identity should be tied to a single user, this should work in practice but it does leave a possibility that a user would edit his Identity from two different repo concurrently and push the changes in a non-centralized network of repositories. In this case, it would result in some of the repo accepting one version and some other accepting another, preventing the network in general to converge to the same result. This would create a sort of partition of the network, and manual cleaning would be required.

An alternative approach would be to have a determinist rebase: - any commits present in both local and remote version would be kept, never changed. - newer commits would be merged in a linear chain of commits, ordered based on the

Lamport time

However, this approach leave the possibility, in the case of a compromised crypto keys, of forging a new version with a bogus Lamport time to be inserted before a legit version, invalidating the correct version and hijacking the Identity. There would only be a short period of time where this would be possible (before the network converge) but I'm not confident enough to implement that. I choose the strict fast-forward only approach, despite it's potential problem with two different version as mentioned above.

func (*Identity) MutableMetadata

func (i *Identity) MutableMetadata() map[string]string

MutableMetadata return all metadata for this Identity, accumulated from each Version. If multiple value are found, the last defined takes precedence.

func (*Identity) Mutate

func (i *Identity) Mutate(f func(orig Mutator) Mutator)

Mutate allow to create a new version of the Identity in one go

func (*Identity) Name

func (i *Identity) Name() string

Name return the last version of the name

func (*Identity) NeedCommit

func (i *Identity) NeedCommit() bool

func (*Identity) SetMetadata

func (i *Identity) SetMetadata(key string, value string)

SetMetadata store arbitrary metadata along the last not-commit Version. If the Version has been commit to git already, a new identical version is added and will need to be commit.

func (*Identity) UnmarshalJSON

func (i *Identity) UnmarshalJSON(data []byte) error

UnmarshalJSON will only read the id Users of this package are expected to run Load() to load the remaining data from the identities data in git.

func (*Identity) ValidKeysAtTime

func (i *Identity) ValidKeysAtTime(time lamport.Time) []*Key

ValidKeysAtTime return the set of keys valid at a given lamport time

func (*Identity) Validate

func (i *Identity) Validate() error

Validate check if the Identity data is valid

type IdentityStub

type IdentityStub struct {
	// contains filtered or unexported fields
}

IdentityStub is an almost empty Identity, holding only the id. When a normal Identity is serialized into JSON, only the id is serialized. All the other data are stored in git in a chain of commit + a ref. When this JSON is deserialized, an IdentityStub is returned instead, to be replaced later by the proper Identity, loaded from the Repo.

func (IdentityStub) AvatarUrl

func (IdentityStub) AvatarUrl() string

func (*IdentityStub) CommitAsNeededWithRepo

func (i *IdentityStub) CommitAsNeededWithRepo(repo repository.ClockedRepo) error

func (IdentityStub) CommitWithRepo

func (IdentityStub) CommitWithRepo(repo repository.ClockedRepo) error

func (IdentityStub) DisplayName

func (IdentityStub) DisplayName() string

func (IdentityStub) Email

func (IdentityStub) Email() string

func (*IdentityStub) Id

func (i *IdentityStub) Id() entity.Id

Id return the Identity identifier

func (IdentityStub) IsProtected

func (IdentityStub) IsProtected() bool

func (IdentityStub) Keys

func (IdentityStub) Keys() []*Key

func (*IdentityStub) LastModification

func (i *IdentityStub) LastModification() timestamp.Timestamp

func (*IdentityStub) LastModificationLamport

func (i *IdentityStub) LastModificationLamport() lamport.Time

func (IdentityStub) Login

func (IdentityStub) Login() string

func (*IdentityStub) MarshalJSON

func (i *IdentityStub) MarshalJSON() ([]byte, error)

func (IdentityStub) Name

func (IdentityStub) Name() string

func (*IdentityStub) NeedCommit

func (i *IdentityStub) NeedCommit() bool

func (*IdentityStub) UnmarshalJSON

func (i *IdentityStub) UnmarshalJSON(data []byte) error

func (IdentityStub) ValidKeysAtTime

func (IdentityStub) ValidKeysAtTime(_ lamport.Time) []*Key

func (IdentityStub) Validate

func (IdentityStub) Validate() error

type Interface

type Interface interface {
	entity.Interface

	// Name return the last version of the name
	// Can be empty.
	Name() string

	// Email return the last version of the email
	// Can be empty.
	Email() string

	// Login return the last version of the login
	// Can be empty.
	// Warning: this login can be defined when importing from a bridge but should *not* be
	// used to identify an identity as multiple bridge with different login can map to the same
	// identity. Use the metadata system for that usage instead.
	Login() string

	// AvatarUrl return the last version of the Avatar URL
	// Can be empty.
	AvatarUrl() string

	// Keys return the last version of the valid keys
	// Can be empty.
	Keys() []*Key

	// ValidKeysAtTime return the set of keys valid at a given lamport time
	// Can be empty.
	ValidKeysAtTime(time lamport.Time) []*Key

	// DisplayName return a non-empty string to display, representing the
	// identity, based on the non-empty values.
	DisplayName() string

	// Validate check if the Identity data is valid
	Validate() error

	// IsProtected return true if the chain of git commits started to be signed.
	// If that's the case, only signed commit with a valid key for this identity can be added.
	IsProtected() bool

	// LastModificationLamportTime return the Lamport time at which the last version of the identity became valid.
	LastModificationLamport() lamport.Time

	// LastModification return the timestamp at which the last version of the identity became valid.
	LastModification() timestamp.Timestamp

	// Indicate that the in-memory state changed and need to be commit in the repository
	NeedCommit() bool
}

func UnmarshalJSON

func UnmarshalJSON(raw json.RawMessage) (Interface, error)

Custom unmarshaling function to allow package user to delegate the decoding of an Identity and distinguish between an Identity and a Bare.

If the given message has a "id" field, it's considered being a proper Identity.

type Key

type Key struct {
	// The GPG fingerprint of the key
	Fingerprint string `json:"fingerprint"`
	PubKey      string `json:"pub_key"`
}

func (*Key) Clone

func (k *Key) Clone() *Key

func (*Key) Validate

func (k *Key) Validate() error

type Mutator

type Mutator struct {
	Name      string
	Login     string
	Email     string
	AvatarUrl string
	Keys      []*Key
}

type Resolver

type Resolver interface {
	ResolveIdentity(id entity.Id) (Interface, error)
}

Resolver define the interface of an Identity resolver, able to load an identity from, for example, a repo or a cache.

type SimpleResolver

type SimpleResolver struct {
	// contains filtered or unexported fields
}

SimpleResolver is a Resolver loading Identities directly from a Repo

func NewSimpleResolver

func NewSimpleResolver(repo repository.Repo) *SimpleResolver

func (*SimpleResolver) ResolveIdentity

func (r *SimpleResolver) ResolveIdentity(id entity.Id) (Interface, error)

type StreamedIdentity

type StreamedIdentity struct {
	Identity *Identity
	Err      error
}

type StubResolver

type StubResolver struct{}

StubResolver is a Resolver that doesn't load anything, only returning IdentityStub instances

func NewStubResolver

func NewStubResolver() *StubResolver

func (*StubResolver) ResolveIdentity

func (s *StubResolver) ResolveIdentity(id entity.Id) (Interface, error)

type Version

type Version struct {
	// contains filtered or unexported fields
}

Version is a complete set of information about an Identity at a point in time.

func (*Version) AllMetadata

func (v *Version) AllMetadata() map[string]string

AllMetadata return all metadata for this Version

func (*Version) Clone

func (v *Version) Clone() *Version

Make a deep copy

func (*Version) GetMetadata

func (v *Version) GetMetadata(key string) (string, bool)

GetMetadata retrieve arbitrary metadata about the Version

func (*Version) MarshalJSON

func (v *Version) MarshalJSON() ([]byte, error)

func (*Version) SetMetadata

func (v *Version) SetMetadata(key string, value string)

SetMetadata store arbitrary metadata about a version or an Identity in general If the Version has been commit to git already, it won't be overwritten.

func (*Version) UnmarshalJSON

func (v *Version) UnmarshalJSON(data []byte) error

func (*Version) Validate

func (v *Version) Validate() error

func (*Version) Write

func (v *Version) Write(repo repository.Repo) (repository.Hash, error)

Write will serialize and store the Version as a git blob and return its hash

type VersionJSON

type VersionJSON struct {
	// Additional field to version the data
	FormatVersion uint `json:"version"`

	Time      lamport.Time      `json:"time"`
	UnixTime  int64             `json:"unix_time"`
	Name      string            `json:"name,omitempty"`
	Email     string            `json:"email,omitempty"`
	Login     string            `json:"login,omitempty"`
	AvatarUrl string            `json:"avatar_url,omitempty"`
	Keys      []*Key            `json:"pub_keys,omitempty"`
	Nonce     []byte            `json:"nonce,omitempty"`
	Metadata  map[string]string `json:"metadata,omitempty"`
}

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier