web

Documentation

Index

• Constants
• Variables
• func CSPDirectives(publicOrigin string, nonce string, cdnHost string, allowInlineScript bool) ([]string, error)
• func GetCSPNonce(ctx context.Context) string
• func GetHashedName(file string) string
• func LookLikeAHash(s string) bool
• func WithCSPNonce(ctx context.Context, nonce string) context.Context
• type CSSDescriptor
  • func (d CSSDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)
  • func (d CSSDescriptor) MatchResource(path string) (*resource.Match, bool)
  • func (d CSSDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, ...) (*resource.ResourceFile, error)
  • func (d CSSDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)
• type EmbeddedResourceManager
• type GlobalEmbeddedResourceManager
  • func NewDefaultGlobalEmbeddedResourceManager() (*GlobalEmbeddedResourceManager, error)
  • func NewGlobalEmbeddedResourceManager(manifest *Manifest) (*GlobalEmbeddedResourceManager, error)
  • func (m *GlobalEmbeddedResourceManager) AssetName(key string) (name string, err error)
  • func (m *GlobalEmbeddedResourceManager) Close() error
  • func (m *GlobalEmbeddedResourceManager) GetManifestContext() *ManifestContext
  • func (m *GlobalEmbeddedResourceManager) ManifestFilePath() string
  • func (m *GlobalEmbeddedResourceManager) Open(name string) (http.File, error)
• type ImageDescriptor
  • func (a ImageDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)
  • func (a ImageDescriptor) MatchResource(path string) (*resource.Match, bool)
  • func (a ImageDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, ...) (*resource.ResourceFile, error)
  • func (a ImageDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)
• type JavaScriptDescriptor
  • func (d JavaScriptDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)
  • func (d JavaScriptDescriptor) MatchResource(path string) (*resource.Match, bool)
  • func (d JavaScriptDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, ...) (*resource.ResourceFile, error)
  • func (d JavaScriptDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)
• type Manifest
• type ManifestContext
• type ResourceManager
• type StaticAsset
• type StaticAssetResolver
  • func (r *StaticAssetResolver) GeneratedStaticAssetURL(key string) (string, error)
  • func (r *StaticAssetResolver) HasAppSpecificAsset(id string) bool
  • func (r *StaticAssetResolver) StaticAssetURL(id string) (string, error)

Constants

const AppAssetsURLDirname = "static"

const GeneratedAssetsURLDirname = "shared-assets"

Variables

var AppLogo = resource.RegisterResource(ImageDescriptor{Name: "app_logo"})

var AppLogoDark = resource.RegisterResource(ImageDescriptor{Name: "app_logo_dark"})

var AuthgearDarkThemeCSS = resource.RegisterResource(CSSDescriptor{
	Path: path.Join(AppAssetsURLDirname, "authgear-dark-theme.css"),
})

var AuthgearLightThemeCSS = resource.RegisterResource(CSSDescriptor{
	Path: path.Join(AppAssetsURLDirname, "authgear-light-theme.css"),
})

var DependencySet = wire.NewSet(
	wire.Struct(new(StaticAssetResolver), "*"),
)

var Favicon = resource.RegisterResource(ImageDescriptor{Name: "favicon"})

var StaticAssetResources = map[string]resource.Descriptor{
	"app-logo":      AppLogo,
	"app-logo-dark": AppLogoDark,
	"favicon":       Favicon,

	"authgear-light-theme.css": AuthgearLightThemeCSS,
	"authgear-dark-theme.css":  AuthgearDarkThemeCSS,
}

var UnsupportedImageFile = apierrors.BadRequest.WithReason("UnsupportedImageFile")

Functions

func CSPDirectives

func CSPDirectives(publicOrigin string, nonce string, cdnHost string, allowInlineScript bool) ([]string, error)

func GetCSPNonce

func GetCSPNonce(ctx context.Context) string

func GetHashedName

func GetHashedName(file string) string

func LookLikeAHash

func LookLikeAHash(s string) bool

func WithCSPNonce

func WithCSPNonce(ctx context.Context, nonce string) context.Context

Types

type CSSDescriptor

type CSSDescriptor struct {
	Path string
}

func (CSSDescriptor) FindResources

func (d CSSDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)

func (CSSDescriptor) MatchResource

func (d CSSDescriptor) MatchResource(path string) (*resource.Match, bool)

func (CSSDescriptor) UpdateResource

func (d CSSDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, data []byte) (*resource.ResourceFile, error)

func (CSSDescriptor) ViewResources

func (d CSSDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)

type EmbeddedResourceManager

type EmbeddedResourceManager interface {
	AssetName(key string) (name string, err error)
}

type GlobalEmbeddedResourceManager

type GlobalEmbeddedResourceManager struct {
	Manifest *Manifest
	// contains filtered or unexported fields
}

func NewDefaultGlobalEmbeddedResourceManager

func NewDefaultGlobalEmbeddedResourceManager() (*GlobalEmbeddedResourceManager, error)

func NewGlobalEmbeddedResourceManager

func NewGlobalEmbeddedResourceManager(manifest *Manifest) (*GlobalEmbeddedResourceManager, error)

func (*GlobalEmbeddedResourceManager) AssetName

func (m *GlobalEmbeddedResourceManager) AssetName(key string) (name string, err error)

func (*GlobalEmbeddedResourceManager) Close

func (m *GlobalEmbeddedResourceManager) Close() error

func (*GlobalEmbeddedResourceManager) GetManifestContext

func (m *GlobalEmbeddedResourceManager) GetManifestContext() *ManifestContext

func (*GlobalEmbeddedResourceManager) ManifestFilePath

func (m *GlobalEmbeddedResourceManager) ManifestFilePath() string

func (*GlobalEmbeddedResourceManager) Open

func (m *GlobalEmbeddedResourceManager) Open(name string) (http.File, error)

type ImageDescriptor

type ImageDescriptor struct {
	Name string
}

func (ImageDescriptor) FindResources

func (a ImageDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)

func (ImageDescriptor) MatchResource

func (a ImageDescriptor) MatchResource(path string) (*resource.Match, bool)

func (ImageDescriptor) UpdateResource

func (a ImageDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, data []byte) (*resource.ResourceFile, error)

func (ImageDescriptor) ViewResources

func (a ImageDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)

type JavaScriptDescriptor

type JavaScriptDescriptor struct {
	Path string
}

func (JavaScriptDescriptor) FindResources

func (d JavaScriptDescriptor) FindResources(fs resource.Fs) ([]resource.Location, error)

func (JavaScriptDescriptor) MatchResource

func (d JavaScriptDescriptor) MatchResource(path string) (*resource.Match, bool)

func (JavaScriptDescriptor) UpdateResource

func (d JavaScriptDescriptor) UpdateResource(_ context.Context, _ []resource.ResourceFile, resrc *resource.ResourceFile, data []byte) (*resource.ResourceFile, error)

func (JavaScriptDescriptor) ViewResources

func (d JavaScriptDescriptor) ViewResources(resources []resource.ResourceFile, rawView resource.View) (interface{}, error)

type Manifest

type Manifest struct {
	ResourceDir string
	Name        string
	// contains filtered or unexported fields
}

type ManifestContext

type ManifestContext struct {
	Content map[string]string
}

type ResourceManager

type ResourceManager interface {
	Read(desc resource.Descriptor, view resource.View) (interface{}, error)
}

type StaticAsset

type StaticAsset struct {
	Path string
	Data []byte
}

type StaticAssetResolver

type StaticAssetResolver struct {
	Context           context.Context
	Config            *config.HTTPConfig
	Localization      *config.LocalizationConfig
	HTTPProto         httputil.HTTPProto
	WebAppCDNHost     config.WebAppCDNHost
	Resources         ResourceManager
	EmbeddedResources EmbeddedResourceManager
}

func (*StaticAssetResolver) GeneratedStaticAssetURL

func (r *StaticAssetResolver) GeneratedStaticAssetURL(key string) (string, error)

func (*StaticAssetResolver) HasAppSpecificAsset

func (r *StaticAssetResolver) HasAppSpecificAsset(id string) bool

func (*StaticAssetResolver) StaticAssetURL

func (r *StaticAssetResolver) StaticAssetURL(id string) (string, error)