link

package

Go to main page

Versions in this module

v0

v0.4.0

Sep 6, 2026

Changes in this version

type Service

+ func (s *Service) RefitQRCodesForPayload(ctx context.Context, workspaceID, linkID uuid.UUID, shortURL string) (int, error)

v0.3.0

Aug 18, 2026

Changes in this version

+ func QROutputSize(content string, style qr.Style) int

+ type LogoFit struct

+ Height int

+ SourceHeight int

+ SourceWidth int

+ Width int

+ func (f LogoFit) Resampled() bool

type QRCode

+ Default bool

+ HasLogo bool

+ ID uuid.UUID

+ Label string

+ Size int

+ Slug string

+ type QRSizeInput struct

+ Background string

+ Foreground string

+ Size int

+ type QRSizeRise struct

+ From int

+ To int

+ func (r QRSizeRise) Rose() bool

type Service

+ func (s *Service) ClearQRCodeLogo(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) error

+ func (s *Service) CreateQRCode(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, label string) (*QRCode, QRSizeRise, error)

+ func (s *Service) DeleteQRCode(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) (promoted *QRCode, err error)

+ func (s *Service) ListQRCodes(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) ([]QRCode, error)

+ func (s *Service) QRCodeBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) (*QRCode, error)

+ func (s *Service) QRCodeLogo(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) ([]byte, error)

+ func (s *Service) RenderQRBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) ([]byte, error)

+ func (s *Service) RenderQRPNG(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) ([]byte, error)

+ func (s *Service) RenderQRPNGBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) ([]byte, error)

+ func (s *Service) ResetQRStyleBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) error

+ func (s *Service) SetDefaultQRCode(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string) (*QRCode, error)

+ func (s *Service) SetQRCodeLabel(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, ...) (*QRCode, error)

+ func (s *Service) SetQRCodeLogo(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string, ...) (*QRCode, LogoFit, error)

+ func (s *Service) SetQRSize(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, in QRSizeInput) (*QRCode, qr.SizeFit, error)

+ func (s *Service) SetQRSizeBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string, ...) (*QRCode, qr.SizeFit, error)

+ func (s *Service) SetQRStyleBySlug(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, slug string, ...) (*QRCode, error)

v0.2.0

Aug 6, 2026

Changes in this version

+ const BlockedAuditRatePerMin

+ const DefaultSignatureTTL

+ const DefaultVerifyGrace

+ const DefaultVerifyInterval

+ const MaxSignatureTTL

+ const PermAutomationRead

+ const PermAutomationWrite

+ const PermWebhooksRead

+ const PermWebhooksWrite

+ const RuleEmbeddedHost

+ const RuleFeedReputation

+ const RuleOperatorBlocklist

+ const RulePrivateAddress

+ const RulePunycodeHomograph

+ const RuleSchemeForbidden

+ const RuleShortenerChain

+ const RuleURLCredentials

+ const SourceEnv

+ const SourceReview

+ const SourceShortener

+ func Defang(raw string) string

+ func HostCandidates(host string) []string

+ func IsRestrictedAddr(addr netip.Addr) bool

+ func LoadRootRedirectWith(ctx context.Context, q *dbgen.Queries) (string, error)

+ func QRContent(shortURL string) string

+ type Block struct

+ Detail string

+ Rule string

+ Tier Tier

+ func (b Block) Error(field string) domain.FieldError

type Config

+ Audit audit.Recorder

+ BlockedAuditLimit KeyLimiter

+ DNS TXTLookup

+ DomainNotify DomainNotifier

+ Events WebhookEmitter

+ Feed FeedChecker

+ FeedMetrics FeedObserver

+ Gates GateReader

+ Hasher *auth.Hasher

+ Hosts HostInvalidator

+ Log *slog.Logger

+ VerifyGrace time.Duration

+ type CreateAutomationRuleInput struct

+ Actions []string

+ Enabled bool

+ Name string

+ Trigger string

+ TriggerConfig domain.AutomationTriggerConfig

+ type CreateCampaignInput struct

+ Description string

+ EndsAt *time.Time

+ Name string

+ Slug string

+ StartsAt *time.Time

+ type CreateFolderInput struct

+ Name string

+ ParentID *uuid.UUID

type CreateInput

+ CampaignID *uuid.UUID

+ DomainID *uuid.UUID

+ FolderID *uuid.UUID

+ ForwardPath bool

+ RequireSignature bool

+ type CreateRuleInput struct

+ Conditions domain.RuleConditions

+ Enabled bool

+ Priority int32

+ URL string

+ type CreateVariantInput struct

+ Enabled bool

+ Kind string

+ URL string

+ Weight int32

+ type CreateWebhookInput struct

+ Description string

+ Enabled bool

+ Events []string

+ URL string

+ type DestinationDisclosure struct

+ Webhooks WebhookDisclosure

+ type Domain struct

+ CreatedAt time.Time

+ Hostname string

+ ID uuid.UUID

+ IsDefault bool

+ LinkCount int64

+ Manageable bool

+ RootRedirectURL string

+ SSLStatus string

+ Scope DomainScope

+ UpdatedAt time.Time

+ Verification *DomainVerification

+ Verified bool

+ VerifiedAt *time.Time

+ type DomainCheckSummary struct

+ Checked int

+ Failing int

+ Unverified int

+ Verified int

+ type DomainNotifier interface

+ WarnDomainFailing func(ctx context.Context, orgID uuid.UUID, workspaceID *uuid.UUID, ...) error

+ WarnDomainUnverified func(ctx context.Context, orgID uuid.UUID, workspaceID *uuid.UUID, ...) error

+ type DomainScope string

+ const ScopeInstance

+ const ScopeOrganization

+ const ScopeWorkspace

type DomainSettings

+ BlockBots bool

+ BlockBotsEnforced bool

+ type DomainVerification struct

+ CheckedAt *time.Time

+ Error string

+ FailingSince *time.Time

+ RecordData string

+ RecordName string

+ RecordType string

+ StopsAt *time.Time

+ type FeedChecker interface

+ Check func(ctx context.Context, destination string) (feed.Result, error)

+ Describe func() feed.Disclosure

+ Name func() string

+ type FeedObserver interface

+ ObserveFeedCheck func(result string)

+ type GateReader interface

+ Budget func(ctx context.Context, linkID uuid.UUID) (int64, *time.Time, error)

+ EnsureSecret func(ctx context.Context, workspaceID uuid.UUID) ([]byte, error)

+ type HostInvalidator interface

+ InvalidateHosts func(ctx context.Context)

type Invalidator

+ InvalidateDomain func(ctx context.Context, domainID uuid.UUID)

+ type KeyLimiter interface

+ AllowKey func(key string) (bool, time.Duration)

+ type LinkDomainBots struct

+ BlockBots bool

+ BlockBotsEnforced bool

+ Hostname string

+ type QRCode struct

+ Content string

+ LinkID uuid.UUID

+ Stored bool

+ Style qr.Style

type Service

+ func (s *Service) ArchiveByRule(ctx context.Context, workspaceID, linkID uuid.UUID) (bool, error)

+ func (s *Service) AutomationRule(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.AutomationRule, error)

+ func (s *Service) AutomationRules(ctx context.Context, actor *auth.Identity) ([]domain.AutomationRule, error)

+ func (s *Service) Campaign(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Campaign, error)

+ func (s *Service) Campaigns(ctx context.Context, actor *auth.Identity) ([]domain.Campaign, error)

+ func (s *Service) CreateAutomationRule(ctx context.Context, actor *auth.Identity, in CreateAutomationRuleInput) (*domain.AutomationRule, error)

+ func (s *Service) CreateCampaign(ctx context.Context, actor *auth.Identity, in CreateCampaignInput) (*domain.Campaign, error)

+ func (s *Service) CreateFolder(ctx context.Context, actor *auth.Identity, in CreateFolderInput) (*domain.Folder, error)

+ func (s *Service) CreateRule(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, ...) (*domain.RoutingRule, error)

+ func (s *Service) CreateVariant(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, ...) (*domain.Variant, error)

+ func (s *Service) CreateWebhook(ctx context.Context, actor *auth.Identity, in CreateWebhookInput) (*domain.Webhook, error)

+ func (s *Service) DeleteAutomationRule(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DeleteCampaign(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DeleteDomain(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DeleteFolder(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DeleteRule(ctx context.Context, actor *auth.Identity, linkID, ruleID uuid.UUID) error

+ func (s *Service) DeleteVariant(ctx context.Context, actor *auth.Identity, linkID, variantID uuid.UUID) error

+ func (s *Service) DeleteWebhook(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DestinationDisclosure(ctx context.Context, actor *auth.Identity) (DestinationDisclosure, error)

+ func (s *Service) Domains(ctx context.Context, actor *auth.Identity) ([]Domain, error)

+ func (s *Service) Folders(ctx context.Context, actor *auth.Identity) (domain.FolderTree, error)

+ func (s *Service) ForgetHostnames()

+ func (s *Service) GetSplit(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) (*domain.Split, error)

+ func (s *Service) Judge(ctx context.Context, raw string) (Verdict, error)

+ func (s *Service) LinkDomainBots(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) (*LinkDomainBots, error)

+ func (s *Service) ListRules(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) ([]domain.RoutingRule, error)

+ func (s *Service) MoveFolder(ctx context.Context, actor *auth.Identity, id uuid.UUID, parentID *uuid.UUID) (*domain.Folder, error)

+ func (s *Service) QRCode(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) (*QRCode, error)

+ func (s *Service) RegisterDomain(ctx context.Context, actor *auth.Identity, rawHostname string) (*Domain, error)

+ func (s *Service) RenameDomain(ctx context.Context, actor *auth.Identity, id uuid.UUID, rawHostname string) (*Domain, error)

+ func (s *Service) RenameFolder(ctx context.Context, actor *auth.Identity, id uuid.UUID, newName string) (*domain.Folder, error)

+ func (s *Service) RenderQR(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) ([]byte, error)

+ func (s *Service) ResetQRStyle(ctx context.Context, actor *auth.Identity, linkID uuid.UUID) error

+ func (s *Service) ReverifyDomains(ctx context.Context, now time.Time, batch int32) (DomainCheckSummary, error)

+ func (s *Service) RotateWebhookSecret(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Webhook, error)

+ func (s *Service) SeedBlocklist(ctx context.Context, hosts []string) error

+ func (s *Service) SetBotBlocking(ctx context.Context, actor *auth.Identity, block, enforced bool) (*DomainSettings, error)

+ func (s *Service) SetDomainRootRedirect(ctx context.Context, actor *auth.Identity, id uuid.UUID, rawURL string) (*Domain, error)

+ func (s *Service) SetQRStyle(ctx context.Context, actor *auth.Identity, linkID uuid.UUID, style qr.Style) (*QRCode, error)

+ func (s *Service) Sign(ctx context.Context, actor *auth.Identity, id uuid.UUID, ttl time.Duration) (*SignedLink, error)

+ func (s *Service) UpdateAutomationRule(ctx context.Context, actor *auth.Identity, id uuid.UUID, ...) (*domain.AutomationRule, error)

+ func (s *Service) UpdateCampaign(ctx context.Context, actor *auth.Identity, id uuid.UUID, ...) (*domain.Campaign, error)

+ func (s *Service) UpdateRule(ctx context.Context, actor *auth.Identity, linkID, ruleID uuid.UUID, ...) (*domain.RoutingRule, error)

+ func (s *Service) UpdateVariant(ctx context.Context, actor *auth.Identity, linkID, variantID uuid.UUID, ...) (*domain.Variant, error)

+ func (s *Service) UpdateWebhook(ctx context.Context, actor *auth.Identity, id uuid.UUID, in UpdateWebhookInput) (*domain.Webhook, error)

+ func (s *Service) VerifyDomain(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*Domain, error)

+ func (s *Service) Webhook(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Webhook, error)

+ func (s *Service) WebhookDeliveries(ctx context.Context, actor *auth.Identity, id uuid.UUID, limit int32) ([]domain.WebhookDelivery, error)

+ func (s *Service) Webhooks(ctx context.Context, actor *auth.Identity) ([]domain.Webhook, error)

+ type SignedLink struct

+ ExpiresAt time.Time

+ URL string

+ type TXTLookup interface

+ LookupTXT func(ctx context.Context, name string) ([]string, error)

+ type Tier string

+ const TierHighConfidence

+ const TierLowConfidence

+ const TierUnappealable

+ func (t Tier) Code(rule string) string

+ type UpdateAutomationRuleInput struct

+ Actions []string

+ Enabled *bool

+ Name *string

+ Trigger *string

+ TriggerConfig *domain.AutomationTriggerConfig

+ type UpdateCampaignInput struct

+ ClearEndsAt bool

+ ClearStartsAt bool

+ Description *string

+ EndsAt *time.Time

+ Name *string

+ Slug *string

+ StartsAt *time.Time

type UpdateInput

+ BotBlocking *domain.BotPolicy

+ CampaignID *uuid.UUID

+ ClearCampaign bool

+ ClearFolder bool

+ ClearMaxClicks bool

+ ClearPassword bool

+ FolderID *uuid.UUID

+ ForwardPath *bool

+ MaxClicks *int64

+ OneTime *bool

+ Password *string

+ RequireSignature *bool

+ type UpdateRuleInput struct

+ Conditions *domain.RuleConditions

+ Enabled *bool

+ Priority *int32

+ URL *string

+ type UpdateVariantInput struct

+ Enabled *bool

+ URL *string

+ Weight *int32

+ type UpdateWebhookInput struct

+ Description *string

+ Enabled *bool

+ Events []string

+ URL *string

+ type Verdict struct

+ Block *Block

+ Errs domain.ValidationErrors

+ Host string

+ ListedHost string

+ Normalized string

+ type WebhookDisclosure struct

+ Count int64

+ Receiving bool

+ type WebhookEmitter interface

+ Emit func(ctx context.Context, workspaceID uuid.UUID, event string, data map[string]any)

v0.1.0

Jul 31, 2026

Changes in this version

+ const PermCreate

+ const PermDelete

+ const PermDomainsWrite

+ const PermRead

+ const PermTagsRead

+ const PermTagsWrite

+ const PermUpdate

+ const TrashRetentionDays

+ func HostOf(rawURL string) string

+ func ValidateDestination(raw string, p DestinationPolicy) (string, error)

+ type Config struct

+ Aliases alias.Policy

+ BaseURL string

+ Cache Invalidator

+ Policy DestinationPolicy

+ RootCache RootInvalidator

+ SplitHosts bool

+ type CreateInput struct

+ Alias string

+ Description string

+ ExpiresAt *time.Time

+ ForwardQuery bool

+ MaxClicks *int64

+ OneTime bool

+ Password string

+ Tags []string

+ Title string

+ URL string

+ type DestinationPolicy struct

+ BlockPrivateIPs bool

+ BlockedHostSuffixes []string

+ MaxLength int

+ Schemes []string

+ func DefaultDestinationPolicy() DestinationPolicy

+ type DomainSettings struct

+ Hostname string

+ RootRedirectURL string

+ SplitHosts bool

+ type Invalidator interface

+ InvalidateAlias func(ctx context.Context, domainID uuid.UUID, alias string)

+ type RootInvalidator interface

+ InvalidateRoot func()

+ type Service struct

+ func NewService(pool *pgxpool.Pool, cfg Config) *Service

+ func (s *Service) Archive(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Link, error)

+ func (s *Service) Create(ctx context.Context, actor *auth.Identity, in CreateInput) (*domain.Link, error)

+ func (s *Service) Delete(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DeleteTag(ctx context.Context, actor *auth.Identity, id uuid.UUID) error

+ func (s *Service) DomainSettings(ctx context.Context, actor *auth.Identity) (*DomainSettings, error)

+ func (s *Service) Get(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Link, error)

+ func (s *Service) List(ctx context.Context, actor *auth.Identity, f domain.LinkFilter) (*domain.Page[domain.Link], error)

+ func (s *Service) ListTags(ctx context.Context, actor *auth.Identity) ([]domain.Tag, error)

+ func (s *Service) LoadRootRedirect(ctx context.Context) (string, error)

+ func (s *Service) Restore(ctx context.Context, actor *auth.Identity, id uuid.UUID) (*domain.Link, error)

+ func (s *Service) SetRootRedirect(ctx context.Context, actor *auth.Identity, rawURL string) (*DomainSettings, error)

+ func (s *Service) Update(ctx context.Context, actor *auth.Identity, id uuid.UUID, in UpdateInput) (*domain.Link, error)

+ type UpdateInput struct

+ Alias *string

+ ClearExpiry bool

+ Description *string

+ ExpiresAt *time.Time

+ ForwardQuery *bool

+ Tags *[]string

+ Title *string

+ URL *string

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