github.com/google/go-safeweb@v0.0.0-20231219055052-64d8cfc90fbb/examples/sample-application/secure/responses/errors.go (about)

     1  // Copyright 2020 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //	https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  //go:build go1.16
    16  // +build go1.16
    17  
    18  package responses
    19  
    20  import (
    21  	"github.com/google/go-safeweb/safehttp"
    22  	"github.com/google/safehtml"
    23  )
    24  
    25  // Error is a safe error response (as recognized by the secure.dispatcher).
    26  //
    27  // This showcases implementing custom safe responses. See
    28  // https://pkg.go.dev/github.com/google/safehtml/template#hdr-Threat_model.
    29  type Error struct {
    30  	StatusCode safehttp.StatusCode
    31  	Message    safehtml.HTML
    32  }
    33  
    34  // NewError creates a new error response.
    35  func NewError(code safehttp.StatusCode, message safehtml.HTML) Error {
    36  	return Error{
    37  		StatusCode: code,
    38  		Message:    message,
    39  	}
    40  }
    41  
    42  // Code returns the HTTP response code.
    43  func (e Error) Code() safehttp.StatusCode {
    44  	return e.StatusCode
    45  }