Documentation
¶
Index ¶
- Constants
- Variables
- type OverridesImporter
- type ProcessMode
- type SelfServiceFrontEndImpl
- func (sfe *SelfServiceFrontEndImpl) BuildID(response http.ResponseWriter, request *http.Request)
- func (sfe *SelfServiceFrontEndImpl) Handler(stats prometheus.Registerer, oTelHTTPOptions ...otelhttp.Option) http.Handler
- func (sfe *SelfServiceFrontEndImpl) Index(response http.ResponseWriter, request *http.Request)
- func (sfe *SelfServiceFrontEndImpl) UnpauseForm(response http.ResponseWriter, request *http.Request)
- func (sfe *SelfServiceFrontEndImpl) UnpauseStatus(response http.ResponseWriter, request *http.Request)
- func (sfe *SelfServiceFrontEndImpl) UnpauseSubmit(response http.ResponseWriter, request *http.Request)
Constants ¶
const ( // Meta fields (not user-entered) ReviewStatusFieldName = "reviewStatus" RateLimitFieldName = "rateLimit" // Shared user-entered fields (UI + API/Zendesk) OrganizationFieldName = "organization" TierFieldName = "tier" AccountURIFieldName = "accountURI" RegisteredDomainFieldName = "registeredDomain" IPAddressFieldName = "ipAddress" )
Variables ¶
var ( // FundraisingOptions is the list of options for the fundraising field. FundraisingOptions = []string{ fundraisingYesOption, "No, not at this time.", } )
Functions ¶
This section is empty.
Types ¶
type OverridesImporter ¶ added in v0.20250908.0
type OverridesImporter struct {
// contains filtered or unexported fields
}
func NewOverridesImporter ¶ added in v0.20250908.0
func NewOverridesImporter(mode ProcessMode, interval time.Duration, client *zendesk.Client, sa rapb.RegistrationAuthorityClient, clk clock.Clock, log blog.Logger) (*OverridesImporter, error)
NewOverridesImporter creates a new OverridesImporter that will process tickets in the given mode at the given interval. An error is returned if the interval is left unspecified.
func (*OverridesImporter) Start ¶ added in v0.20250908.0
func (im *OverridesImporter) Start(ctx context.Context)
Start begins the periodic import of approved override requests from Zendesk. This method blocks until the provided context is cancelled.
type ProcessMode ¶ added in v0.20250908.0
type ProcessMode string
ProcessMode determines which ticket IDs the importer will process.
const ( // ProcessAll indicates that all tickets should be processed, as opposed to // just even or odd numbered tickets. ProcessAll ProcessMode = "all" )
type SelfServiceFrontEndImpl ¶
type SelfServiceFrontEndImpl struct {
// contains filtered or unexported fields
}
SelfServiceFrontEndImpl provides all the logic for Boulder's selfservice frontend web-facing interface, i.e., a portal where a subscriber can unpause their account. Its methods are primarily handlers for HTTPS requests for the various non-ACME functions.
func NewSelfServiceFrontEndImpl ¶
func NewSelfServiceFrontEndImpl( stats prometheus.Registerer, clk clock.Clock, logger blog.Logger, requestTimeout time.Duration, rac rapb.RegistrationAuthorityClient, sac sapb.StorageAuthorityReadOnlyClient, eec emailpb.ExporterClient, unpauseHMACKey []byte, zendeskClient *zendesk.Client, limiter *rl.Limiter, txnBuilder *rl.TransactionBuilder, autoApproveOverrides bool, ) (SelfServiceFrontEndImpl, error)
NewSelfServiceFrontEndImpl constructs a web service for Boulder
func (*SelfServiceFrontEndImpl) BuildID ¶
func (sfe *SelfServiceFrontEndImpl) BuildID(response http.ResponseWriter, request *http.Request)
BuildID tells the requester what boulder build version is running.
func (*SelfServiceFrontEndImpl) Handler ¶
func (sfe *SelfServiceFrontEndImpl) Handler(stats prometheus.Registerer, oTelHTTPOptions ...otelhttp.Option) http.Handler
Handler returns an http.Handler that uses various functions for various non-ACME-specified paths. Each endpoint should have a corresponding HTML page that shares the same name as the endpoint.
func (*SelfServiceFrontEndImpl) Index ¶
func (sfe *SelfServiceFrontEndImpl) Index(response http.ResponseWriter, request *http.Request)
Index is the homepage of the SFE
func (*SelfServiceFrontEndImpl) UnpauseForm ¶
func (sfe *SelfServiceFrontEndImpl) UnpauseForm(response http.ResponseWriter, request *http.Request)
UnpauseForm allows a requester to unpause their account via a form present on the page. The Subscriber's client will receive a log line emitted by the WFE which contains a URL pre-filled with a JWT that will populate a hidden field in this form.
func (*SelfServiceFrontEndImpl) UnpauseStatus ¶
func (sfe *SelfServiceFrontEndImpl) UnpauseStatus(response http.ResponseWriter, request *http.Request)
UnpauseStatus displays a success message to the Subscriber indicating that their account has been unpaused.
func (*SelfServiceFrontEndImpl) UnpauseSubmit ¶
func (sfe *SelfServiceFrontEndImpl) UnpauseSubmit(response http.ResponseWriter, request *http.Request)
UnpauseSubmit serves a page showing the result of the unpause form submission. CSRF is not addressed because a third party causing submission of an unpause form is not harmful.
Source Files
Directories