Documentation
¶
Index ¶
- Variables
- type AuthServer
- func (x *AuthServer) ClearServer()
- func (x *AuthServer) GetJwtSigningToken() string
- func (x *AuthServer) GetServer() *v11.Server
- func (x *AuthServer) HasServer() bool
- func (*AuthServer) ProtoMessage()
- func (x *AuthServer) ProtoReflect() protoreflect.Message
- func (x *AuthServer) Reset()
- func (x *AuthServer) SetJwtSigningToken(v string)
- func (x *AuthServer) SetServer(v *v11.Server)
- func (x *AuthServer) String() string
- type AuthServer_builder
- type AuthUser
- func (x *AuthUser) ClearUser()
- func (x *AuthUser) GetHashedPassword() string
- func (x *AuthUser) GetUser() *v1.User
- func (x *AuthUser) HasUser() bool
- func (*AuthUser) ProtoMessage()
- func (x *AuthUser) ProtoReflect() protoreflect.Message
- func (x *AuthUser) Reset()
- func (x *AuthUser) SetHashedPassword(v string)
- func (x *AuthUser) SetUser(v *v1.User)
- func (x *AuthUser) String() string
- type AuthUser_builder
- type LoginRequest
- func (x *LoginRequest) GetEmail() string
- func (x *LoginRequest) GetPassword() string
- func (*LoginRequest) ProtoMessage()
- func (x *LoginRequest) ProtoReflect() protoreflect.Message
- func (x *LoginRequest) Reset()
- func (x *LoginRequest) SetEmail(v string)
- func (x *LoginRequest) SetPassword(v string)
- func (x *LoginRequest) String() string
- type LoginRequest_builder
- type LoginResponse
- func (x *LoginResponse) ClearUser()
- func (x *LoginResponse) GetAccessToken() string
- func (x *LoginResponse) GetRefreshToken() string
- func (x *LoginResponse) GetUser() *v1.User
- func (x *LoginResponse) HasUser() bool
- func (*LoginResponse) ProtoMessage()
- func (x *LoginResponse) ProtoReflect() protoreflect.Message
- func (x *LoginResponse) Reset()
- func (x *LoginResponse) SetAccessToken(v string)
- func (x *LoginResponse) SetRefreshToken(v string)
- func (x *LoginResponse) SetUser(v *v1.User)
- func (x *LoginResponse) String() string
- type LoginResponse_builder
- type RefreshTokenRequest
- func (x *RefreshTokenRequest) GetRefreshToken() string
- func (*RefreshTokenRequest) ProtoMessage()
- func (x *RefreshTokenRequest) ProtoReflect() protoreflect.Message
- func (x *RefreshTokenRequest) Reset()
- func (x *RefreshTokenRequest) SetRefreshToken(v string)
- func (x *RefreshTokenRequest) String() string
- type RefreshTokenRequest_builder
- type RefreshTokenResponse
- func (x *RefreshTokenResponse) GetAccessToken() string
- func (*RefreshTokenResponse) ProtoMessage()
- func (x *RefreshTokenResponse) ProtoReflect() protoreflect.Message
- func (x *RefreshTokenResponse) Reset()
- func (x *RefreshTokenResponse) SetAccessToken(v string)
- func (x *RefreshTokenResponse) String() string
- type RefreshTokenResponse_builder
- type RegisterRequest
- func (x *RegisterRequest) GetEmail() string
- func (x *RegisterRequest) GetName() string
- func (x *RegisterRequest) GetPassword() string
- func (*RegisterRequest) ProtoMessage()
- func (x *RegisterRequest) ProtoReflect() protoreflect.Message
- func (x *RegisterRequest) Reset()
- func (x *RegisterRequest) SetEmail(v string)
- func (x *RegisterRequest) SetName(v string)
- func (x *RegisterRequest) SetPassword(v string)
- func (x *RegisterRequest) String() string
- type RegisterRequest_builder
- type RegisterResponse
- type RegisterResponse_builder
Constants ¶
This section is empty.
Variables ¶
View Source
var File_listenup_auth_v1_auth_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AuthServer ¶
type AuthServer struct {
// The embedded server type
Server *v11.Server `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"`
// The string responsible for signing JWT tokens.
JwtSigningToken string `protobuf:"bytes,2,opt,name=jwt_signing_token,json=jwtSigningToken,proto3" json:"jwt_signing_token,omitempty"`
// contains filtered or unexported fields
}
We use this in a similar way to the AuthUser type. As a wrapper with extra information only the server needs. This will never be returned to the client.
func (*AuthServer) ClearServer ¶
func (x *AuthServer) ClearServer()
func (*AuthServer) GetJwtSigningToken ¶
func (x *AuthServer) GetJwtSigningToken() string
func (*AuthServer) GetServer ¶
func (x *AuthServer) GetServer() *v11.Server
func (*AuthServer) HasServer ¶
func (x *AuthServer) HasServer() bool
func (*AuthServer) ProtoMessage ¶
func (*AuthServer) ProtoMessage()
func (*AuthServer) ProtoReflect ¶
func (x *AuthServer) ProtoReflect() protoreflect.Message
func (*AuthServer) Reset ¶
func (x *AuthServer) Reset()
func (*AuthServer) SetJwtSigningToken ¶
func (x *AuthServer) SetJwtSigningToken(v string)
func (*AuthServer) SetServer ¶
func (x *AuthServer) SetServer(v *v11.Server)
func (*AuthServer) String ¶
func (x *AuthServer) String() string
type AuthServer_builder ¶
type AuthServer_builder struct {
// The embedded server type
Server *v11.Server
// The string responsible for signing JWT tokens.
JwtSigningToken string
// contains filtered or unexported fields
}
func (AuthServer_builder) Build ¶
func (b0 AuthServer_builder) Build() *AuthServer
type AuthUser ¶
type AuthUser struct {
// Holds a reference to the User, this is really the only data we use outside of auth purposes
User *v1.User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
// The users password, for authentication/authorization
HashedPassword string `protobuf:"bytes,2,opt,name=hashed_password,json=hashedPassword,proto3" json:"hashed_password,omitempty"`
// contains filtered or unexported fields
}
This is the type that gets stored in our database ultimately, but is only used for Auth purposes and will never be returned to the client.
func (*AuthUser) ProtoReflect ¶
func (x *AuthUser) ProtoReflect() protoreflect.Message
type AuthUser_builder ¶
type AuthUser_builder struct {
// Holds a reference to the User, this is really the only data we use outside of auth purposes
User *v1.User
// The users password, for authentication/authorization
HashedPassword string
// contains filtered or unexported fields
}
func (AuthUser_builder) Build ¶
func (b0 AuthUser_builder) Build() *AuthUser
type LoginRequest ¶
type LoginRequest struct {
// The users email
Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
// The users un-hashed password
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
// contains filtered or unexported fields
}
func (*LoginRequest) GetEmail ¶
func (x *LoginRequest) GetEmail() string
func (*LoginRequest) GetPassword ¶
func (x *LoginRequest) GetPassword() string
func (*LoginRequest) ProtoMessage ¶
func (*LoginRequest) ProtoMessage()
func (*LoginRequest) ProtoReflect ¶
func (x *LoginRequest) ProtoReflect() protoreflect.Message
func (*LoginRequest) Reset ¶
func (x *LoginRequest) Reset()
func (*LoginRequest) SetEmail ¶
func (x *LoginRequest) SetEmail(v string)
func (*LoginRequest) SetPassword ¶
func (x *LoginRequest) SetPassword(v string)
func (*LoginRequest) String ¶
func (x *LoginRequest) String() string
type LoginRequest_builder ¶
type LoginRequest_builder struct {
// The users email
Email string
// The users un-hashed password
Password string
// contains filtered or unexported fields
}
func (LoginRequest_builder) Build ¶
func (b0 LoginRequest_builder) Build() *LoginRequest
type LoginResponse ¶
type LoginResponse struct {
// The access token, used as an authorization mechanism for future requests.
AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
// The user themselves.
User *v1.User `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
// Refresh token
RefreshToken string `protobuf:"bytes,3,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
// contains filtered or unexported fields
}
func (*LoginResponse) ClearUser ¶
func (x *LoginResponse) ClearUser()
func (*LoginResponse) GetAccessToken ¶
func (x *LoginResponse) GetAccessToken() string
func (*LoginResponse) GetRefreshToken ¶
func (x *LoginResponse) GetRefreshToken() string
func (*LoginResponse) GetUser ¶
func (x *LoginResponse) GetUser() *v1.User
func (*LoginResponse) HasUser ¶
func (x *LoginResponse) HasUser() bool
func (*LoginResponse) ProtoMessage ¶
func (*LoginResponse) ProtoMessage()
func (*LoginResponse) ProtoReflect ¶
func (x *LoginResponse) ProtoReflect() protoreflect.Message
func (*LoginResponse) Reset ¶
func (x *LoginResponse) Reset()
func (*LoginResponse) SetAccessToken ¶
func (x *LoginResponse) SetAccessToken(v string)
func (*LoginResponse) SetRefreshToken ¶
func (x *LoginResponse) SetRefreshToken(v string)
func (*LoginResponse) SetUser ¶
func (x *LoginResponse) SetUser(v *v1.User)
func (*LoginResponse) String ¶
func (x *LoginResponse) String() string
type LoginResponse_builder ¶
type LoginResponse_builder struct {
// The access token, used as an authorization mechanism for future requests.
AccessToken string
// The user themselves.
User *v1.User
// Refresh token
RefreshToken string
// contains filtered or unexported fields
}
func (LoginResponse_builder) Build ¶
func (b0 LoginResponse_builder) Build() *LoginResponse
type RefreshTokenRequest ¶
type RefreshTokenRequest struct {
// The users current refresh token
RefreshToken string `protobuf:"bytes,1,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
// contains filtered or unexported fields
}
func (*RefreshTokenRequest) GetRefreshToken ¶
func (x *RefreshTokenRequest) GetRefreshToken() string
func (*RefreshTokenRequest) ProtoMessage ¶
func (*RefreshTokenRequest) ProtoMessage()
func (*RefreshTokenRequest) ProtoReflect ¶
func (x *RefreshTokenRequest) ProtoReflect() protoreflect.Message
func (*RefreshTokenRequest) Reset ¶
func (x *RefreshTokenRequest) Reset()
func (*RefreshTokenRequest) SetRefreshToken ¶
func (x *RefreshTokenRequest) SetRefreshToken(v string)
func (*RefreshTokenRequest) String ¶
func (x *RefreshTokenRequest) String() string
type RefreshTokenRequest_builder ¶
type RefreshTokenRequest_builder struct {
// The users current refresh token
RefreshToken string
// contains filtered or unexported fields
}
func (RefreshTokenRequest_builder) Build ¶
func (b0 RefreshTokenRequest_builder) Build() *RefreshTokenRequest
type RefreshTokenResponse ¶
type RefreshTokenResponse struct {
// Updated app access token
AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
// contains filtered or unexported fields
}
func (*RefreshTokenResponse) GetAccessToken ¶
func (x *RefreshTokenResponse) GetAccessToken() string
func (*RefreshTokenResponse) ProtoMessage ¶
func (*RefreshTokenResponse) ProtoMessage()
func (*RefreshTokenResponse) ProtoReflect ¶
func (x *RefreshTokenResponse) ProtoReflect() protoreflect.Message
func (*RefreshTokenResponse) Reset ¶
func (x *RefreshTokenResponse) Reset()
func (*RefreshTokenResponse) SetAccessToken ¶
func (x *RefreshTokenResponse) SetAccessToken(v string)
func (*RefreshTokenResponse) String ¶
func (x *RefreshTokenResponse) String() string
type RefreshTokenResponse_builder ¶
type RefreshTokenResponse_builder struct {
// Updated app access token
AccessToken string
// contains filtered or unexported fields
}
func (RefreshTokenResponse_builder) Build ¶
func (b0 RefreshTokenResponse_builder) Build() *RefreshTokenResponse
type RegisterRequest ¶
type RegisterRequest struct {
// The users email (we don't do any verification logic with this yet, but may in the future)
Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
// The users name, this will be used as a visual identifier throughout the app
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// The users un-hashed password
Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty"`
// contains filtered or unexported fields
}
func (*RegisterRequest) GetEmail ¶
func (x *RegisterRequest) GetEmail() string
func (*RegisterRequest) GetName ¶
func (x *RegisterRequest) GetName() string
func (*RegisterRequest) GetPassword ¶
func (x *RegisterRequest) GetPassword() string
func (*RegisterRequest) ProtoMessage ¶
func (*RegisterRequest) ProtoMessage()
func (*RegisterRequest) ProtoReflect ¶
func (x *RegisterRequest) ProtoReflect() protoreflect.Message
func (*RegisterRequest) Reset ¶
func (x *RegisterRequest) Reset()
func (*RegisterRequest) SetEmail ¶
func (x *RegisterRequest) SetEmail(v string)
func (*RegisterRequest) SetName ¶
func (x *RegisterRequest) SetName(v string)
func (*RegisterRequest) SetPassword ¶
func (x *RegisterRequest) SetPassword(v string)
func (*RegisterRequest) String ¶
func (x *RegisterRequest) String() string
type RegisterRequest_builder ¶
type RegisterRequest_builder struct {
// The users email (we don't do any verification logic with this yet, but may in the future)
Email string
// The users name, this will be used as a visual identifier throughout the app
Name string
// The users un-hashed password
Password string
// contains filtered or unexported fields
}
func (RegisterRequest_builder) Build ¶
func (b0 RegisterRequest_builder) Build() *RegisterRequest
type RegisterResponse ¶
type RegisterResponse struct {
// contains filtered or unexported fields
}
We don't send anything back at this point except success or failure codes.
func (*RegisterResponse) ProtoMessage ¶
func (*RegisterResponse) ProtoMessage()
func (*RegisterResponse) ProtoReflect ¶
func (x *RegisterResponse) ProtoReflect() protoreflect.Message
func (*RegisterResponse) Reset ¶
func (x *RegisterResponse) Reset()
func (*RegisterResponse) String ¶
func (x *RegisterResponse) String() string
type RegisterResponse_builder ¶
type RegisterResponse_builder struct {
// contains filtered or unexported fields
}
func (RegisterResponse_builder) Build ¶
func (b0 RegisterResponse_builder) Build() *RegisterResponse
Source Files
¶
- auth.pb.go
Click to show internal directories.
Click to hide internal directories.