Documentation ¶
Index ¶
- Variables
- func AppendJSONToOpaque(o *types.Opaque, key string, value interface{}) *types.Opaque
- func AppendPlainToOpaque(o *types.Opaque, key, value string) *types.Opaque
- func ExistsInOpaque(o *types.Opaque, key string) bool
- func ExtractGranteeID(grantee *provider.Grantee) (*userpb.UserId, *grouppb.GroupId)
- func GetClientIP(r *http.Request) (string, error)
- func GetLDAPClientForAuth(c *LDAPConn) (ldap.Client, error)
- func GetLDAPClientWithReconnect(c *LDAPConn) (ldap.Client, error)
- func GetUser(userID *user.UserId, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (*user.User, error)
- func GetViewMode(viewMode string) gateway.OpenInAppRequest_ViewMode
- func GranteeEqual(u, v *provider.Grantee) bool
- func GroupEqual(u, v *grouppb.GroupId) bool
- func Impersonate(userID *user.UserId, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (context.Context, *user.User, error)
- func ImpersonateUser(usr *user.User, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (context.Context, error)
- func IsAbsolutePathReference(ref *provider.Reference) bool
- func IsAbsoluteReference(ref *provider.Reference) bool
- func IsEmailValid(e string) bool
- func IsRelativeReference(ref *provider.Reference) bool
- func IsValidName(name string) bool
- func IsValidPhoneNumber(number string) bool
- func IsValidWebAddress(address string) bool
- func LaterTS(t1 *types.Timestamp, t2 *types.Timestamp) *types.Timestamp
- func MTimeToTS(v string) (ts types.Timestamp, err error)
- func MTimeToTime(v string) (t time.Time, err error)
- func MakeRelativePath(p string) string
- func MarshalProtoV1ToJSON(m proto.Message) ([]byte, error)
- func MergeOpaques(o *types.Opaque, p *types.Opaque) *types.Opaque
- func RandString(n int) string
- func ReadJSONFromOpaque(o *types.Opaque, key string, valptr interface{}) error
- func ReadPlainFromOpaque(o *types.Opaque, key string) string
- func RemoveItem(path string) error
- func ResolvePath(path string) (string, error)
- func ResourceEqual(u, v *provider.Reference) bool
- func ResourceIDEqual(u, v *provider.ResourceId) bool
- func Skip(source string, prefixes []string) bool
- func TSNow() *types.Timestamp
- func TSToTime(ts *types.Timestamp) time.Time
- func TSToUnixNano(ts *types.Timestamp) uint64
- func TimeToTS(t time.Time) *types.Timestamp
- func ToSnakeCase(str string) string
- func UnmarshalJSONToProtoV1(b []byte, m proto.Message) error
- func UserEqual(u, v *userpb.UserId) bool
- func UserIDEqual(u, v *userpb.UserId) bool
- func UserTypeMap(accountType string) userpb.UserType
- func UserTypeToString(accountType userpb.UserType) string
- type LDAPConn
Constants ¶
This section is empty.
Variables ¶
var ( // PublicStorageProviderID is the storage id used by the sharestorageprovider PublicStorageProviderID = "7993447f-687f-490d-875c-ac95e89a62a4" // PublicStorageSpaceID is the space id used by the sharestorageprovider PublicStorageSpaceID = "7993447f-687f-490d-875c-ac95e89a62a4" // SpaceGrant is used to signal the storageprovider that the grant is on a space SpaceGrant struct{} )ShareStorageProviderID = "a0ca6a90-a365-4782-871e-d44447bbc668" ShareStorageSpaceID = "a0ca6a90-a365-4782-871e-d44447bbc668"
Functions ¶
func AppendJSONToOpaque ¶ added in v2.13.0
AppendJSONToOpaque adds a new key value pair as a json on the given opaque and returns it. Ignores errors
func AppendPlainToOpaque ¶
AppendPlainToOpaque adds a new key value pair as a plain string on the given opaque and returns it
func ExistsInOpaque ¶ added in v2.1.0
ExistsInOpaque returns true if the key exists in the opaque (ignoring the value)
func ExtractGranteeID ¶
ExtractGranteeID returns the ID, user or group, set in the GranteeId object
func GetClientIP ¶
GetClientIP retrieves the client IP from incoming requests
func GetLDAPClientForAuth ¶ added in v2.2.0
GetLDAPClientForAuth initializes an LDAP connection. The connection is not authenticated when returned. The main purpose for GetLDAPClientForAuth is to get and LDAP connection that can be used to issue a single bind request to authenticate a user.
func GetLDAPClientWithReconnect ¶ added in v2.2.0
GetLDAPClientWithReconnect initializes a long-lived LDAP connection that automatically reconnects on connection errors. It allows to set TLS options e.g. to add trusted Certificates or disable Certificate verification
func GetUser ¶ added in v2.13.0
func GetUser(userID *user.UserId, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (*user.User, error)
GetUser gets the specified user
func GetViewMode ¶
func GetViewMode(viewMode string) gateway.OpenInAppRequest_ViewMode
GetViewMode converts a human-readable string to a view mode for opening a resource in an app.
func GranteeEqual ¶
GranteeEqual returns whether two grantees have the same field values.
func GroupEqual ¶
GroupEqual returns whether two groups have the same field values.
func Impersonate ¶ added in v2.13.0
func Impersonate(userID *user.UserId, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (context.Context, *user.User, error)
Impersonate returns an authenticated reva context and the user it represents
func ImpersonateUser ¶ added in v2.13.0
func ImpersonateUser(usr *user.User, gwc gateway.GatewayAPIClient, machineAuthAPIKey string) (context.Context, error)
ImpersonateUser impersonates the given user
func IsAbsolutePathReference ¶
IsAbsolutePathReference returns true if the given reference qualifies as a global path when only the path is set and starts with /
func IsAbsoluteReference ¶
IsAbsoluteReference returns true if the given reference qualifies as absolute when either only the resource id is set or only the path is set and starts with /
TODO(corby): Currently if the path is empty, the ResourceId is set but has empty storageId and OpaqueId then the reference is still being viewed as absolute. We need to check if we want that because in some places we might not want to set both StorageId and OpaqueId so we can't do a hard check if they are set.
func IsEmailValid ¶
IsEmailValid checks whether the provided email has a valid format.
func IsRelativeReference ¶
IsRelativeReference returns true if the given reference qualifies as relative when the resource id is set and the path starts with a .
TODO(corby): Currently if the path begins with a dot, the ResourceId is set but has empty storageId and OpaqueId then the reference is still being viewed as relative. We need to check if we want that because in some places we might not want to set both StorageId and OpaqueId so we can't do a hard check if they are set.
func IsValidName ¶
IsValidName cheks if the given name doesn't contain any non-alpha, space or dash characters.
func IsValidPhoneNumber ¶
IsValidPhoneNumber checks whether the provided phone number has a valid format.
func IsValidWebAddress ¶
IsValidWebAddress checks whether the provided address is a valid URL.
func MTimeToTS ¶ added in v2.8.0
MTimeToTS converts a string in the form "<unix>.<nanoseconds>" into a CS3 Timestamp
func MTimeToTime ¶ added in v2.16.0
MTimeToTime converts a string in the form "<unix>.<nanoseconds>" into a go time.Time
func MakeRelativePath ¶
MakeRelativePath prefixes the path with a . to use it in a relative reference
func MarshalProtoV1ToJSON ¶
MarshalProtoV1ToJSON marshals a proto V1 message to a JSON byte array TODO: update this once we start using V2 in CS3APIs
func MergeOpaques ¶ added in v2.6.0
MergeOpaques will merge the opaques. If a key exists in both opaques the values from the first opaque will be taken
func ReadJSONFromOpaque ¶ added in v2.13.0
ReadJSONFromOpaque reads and unmarshals a value from the opaque in the given interface{} (Make sure it's a pointer!)
func ReadPlainFromOpaque ¶
ReadPlainFromOpaque reads a plain string from the given opaque map
func RemoveItem ¶ added in v2.4.0
RemoveItem removes the given item, its children and all empty parent folders
func ResolvePath ¶
ResolvePath converts relative local paths to absolute paths
func ResourceEqual ¶
ResourceEqual returns whether two resources have the same field values.
func ResourceIDEqual ¶
func ResourceIDEqual(u, v *provider.ResourceId) bool
ResourceIDEqual returns whether two resources have the same field values.
func Skip ¶
Skip evaluates whether a source endpoint contains any of the prefixes. i.e: /a/b/c/d/e contains prefix /a/b/c
func TSToUnixNano ¶
TSToUnixNano converts a protobuf Timestamp to uint64 with nanoseconds resolution.
func ToSnakeCase ¶
ToSnakeCase converts a CamelCase string to a snake_case string.
func UnmarshalJSONToProtoV1 ¶
UnmarshalJSONToProtoV1 decodes a JSON byte array to a specified proto message type TODO: update this once we start using V2 in CS3APIs
func UserIDEqual ¶ added in v2.11.0
UserIDEqual returns whether two users have the same opaqueid values. The idp is ignored
func UserTypeMap ¶
UserTypeMap translates account type string to CS3 UserType
func UserTypeToString ¶
UserTypeToString translates CS3 UserType to user-readable string
Types ¶
type LDAPConn ¶
type LDAPConn struct { URI string `mapstructure:"uri"` Insecure bool `mapstructure:"insecure"` CACert string `mapstructure:"cacert"` BindDN string `mapstructure:"bind_username"` BindPassword string `mapstructure:"bind_password"` }
LDAPConn holds the basic parameter for setting up an LDAP connection.