package sa
Get desktop application:
View/edit binary Protocol Buffers messages
service StorageAuthority
sa.proto:43StorageAuthority provides full read/write access to the database.
rpc AddBlockedKey (, )
sa.proto:74Adders
message
sa.proto:322bytes keyHash = 1
Next unused field number: 7
optional added = 6
string source = 3
string comment = 4
int64 revokedBy = 5
rpc AddCertificate (, )
sa.proto:75rpc AddPrecertificate (, )
sa.proto:76rpc AddRateLimitOverride (, )
sa.proto:93message
sa.proto:455optional override = 1
bool force = 2
message
sa.proto:460bool inserted = 1
bool enabled = 2
optional existing = 3
rpc AddSerial (, )
sa.proto:77message
sa.proto:183int64 regID = 1
Next unused field number: 7
string serial = 2
optional created = 5
optional expires = 6
rpc CheckIdentifiersPaused (, )
sa.proto:68rpc DeactivateAuthorization2 (, )
sa.proto:78rpc DeactivateRegistration (, )
sa.proto:79rpc DisableRateLimitOverride (, )
sa.proto:94message
sa.proto:471int64 limitEnum = 1
string bucketKey = 2
rpc EnableRateLimitOverride (, )
sa.proto:95message
sa.proto:466int64 limitEnum = 1
string bucketKey = 2
rpc FQDNSetExists (, )
sa.proto:45Getters: this list must be identical to the StorageAuthorityReadOnly rpcs.
rpc FinalizeAuthorization2 (, )
sa.proto:80message
sa.proto:309int64 id = 1
Next unused field number: 10
string status = 2
optional expires = 8
string attempted = 4
repeated validationRecords = 5
optional validationError = 6
optional attemptedAt = 9
rpc FinalizeOrder (, )
sa.proto:81message
sa.proto:273int64 id = 1
string certificateSerial = 2
rpc GetAuthorization2 (, )
sa.proto:47rpc GetCertificate (, )
sa.proto:48rpc GetCertificateStatus (, )
sa.proto:50rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:71rpc GetLintPrecertificate (, )
sa.proto:49rpc GetOrder (, )
sa.proto:51rpc GetOrderAuthorizations (, )
sa.proto:62rpc GetOrderForNames (, )
sa.proto:52rpc GetPausedIdentifiers (, )
sa.proto:69rpc GetRateLimitOverride (, )
sa.proto:70rpc GetRegistration (, )
sa.proto:53rpc GetRegistrationByKey (, )
sa.proto:54rpc GetRevocationStatus (, )
sa.proto:55rpc GetRevokedCertsByShard (, stream )
sa.proto:56rpc GetSerialMetadata (, )
sa.proto:57rpc GetSerialsByAccount (, stream )
sa.proto:58rpc GetSerialsByKey (, stream )
sa.proto:59rpc GetValidAuthorizations2 (, )
sa.proto:60rpc IncidentsForSerial (, )
sa.proto:63rpc KeyBlocked (, )
sa.proto:64rpc LeaseCRLShard (, )
sa.proto:89message
sa.proto:408int64 issuerNameID = 1
int64 minShardIdx = 2
int64 maxShardIdx = 3
optional until = 4
message
sa.proto:415int64 issuerNameID = 1
int64 shardIdx = 2
rpc ListIncidents (, )
sa.proto:65rpc NewOrderAndAuthzs (, )
sa.proto:82message
sa.proto:246optional newOrder = 1
repeated newAuthzs = 2
Authorizations to be newly created alongside the order, and associated with it. These will be combined with any reused authorizations (newOrder.v2Authorizations) to make the overall set of authorizations for the order. This field and newOrder.v2Authorizations may both be present, or only one of the two may be present, but they may not both be absent.
rpc NewRegistration (, )
sa.proto:83rpc PauseIdentifiers (, )
sa.proto:91message
sa.proto:436int64 paused = 1
int64 repaused = 2
rpc ReplacementOrderExists (, )
sa.proto:66rpc RevokeCertificate (, )
sa.proto:84rpc SerialsForIncident (, stream )
sa.proto:67rpc SetOrderError (, )
sa.proto:85message
sa.proto:256int64 id = 1
optional error = 2
rpc SetOrderProcessing (, )
sa.proto:86rpc UnpauseAccount (, )
sa.proto:92message
sa.proto:145int64 count = 1
rpc UpdateCRLShard (, )
sa.proto:90message
sa.proto:420int64 issuerNameID = 1
int64 shardIdx = 2
optional thisUpdate = 3
optional nextUpdate = 4
rpc UpdateRegistrationKey (, )
sa.proto:87message
sa.proto:441int64 registrationID = 1
bytes jwk = 2
rpc UpdateRevokedCertificate (, )
sa.proto:88
service StorageAuthorityAdmin
sa.proto:99StorageAuthorityAdmin exposes those SA methods exclusive to the admin tool.
rpc AddSerialsToIncident (stream , )
sa.proto:102message
sa.proto:371oneof payload
metadata = 1
batch = 2
rpc CreateIncident (, )
sa.proto:100message
sa.proto:354string serialTable = 1
string url = 2
optional renewBy = 3
rpc UpdateIncident (, )
sa.proto:101message
sa.proto:364UpdateIncidentRequest updates a subset of the metadata fields on the incidents row identified by serialTable. An empty url, nil renewBy, and nil enabled all mean "leave that field alone"; at least one of them must be set.
string serialTable = 1
string url = 2
optional renewBy = 3
optional bool enabled = 4
StorageAuthorityReadOnly exposes only those SA methods which are read-only.
rpc CheckIdentifiersPaused (, )
sa.proto:36rpc FQDNSetExists (, )
sa.proto:13rpc GetAuthorization2 (, )
sa.proto:15rpc GetCertificate (, )
sa.proto:16rpc GetCertificateStatus (, )
sa.proto:18rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:39rpc GetLintPrecertificate (, )
sa.proto:17rpc GetOrder (, )
sa.proto:19rpc GetOrderAuthorizations (, )
sa.proto:30rpc GetOrderForNames (, )
sa.proto:20rpc GetPausedIdentifiers (, )
sa.proto:37rpc GetRateLimitOverride (, )
sa.proto:38rpc GetRegistration (, )
sa.proto:21rpc GetRegistrationByKey (, )
sa.proto:22rpc GetRevocationStatus (, )
sa.proto:23rpc GetRevokedCertsByShard (, stream )
sa.proto:24rpc GetSerialMetadata (, )
sa.proto:25rpc GetSerialsByAccount (, stream )
sa.proto:26rpc GetSerialsByKey (, stream )
sa.proto:27rpc GetValidAuthorizations2 (, )
sa.proto:28rpc IncidentsForSerial (, )
sa.proto:31rpc KeyBlocked (, )
sa.proto:32rpc ListIncidents (, )
sa.proto:33rpc ReplacementOrderExists (, )
sa.proto:34rpc SerialsForIncident (, stream )
sa.proto:35
message
sa.proto:193Used as request type in: StorageAuthority.AddCertificate, StorageAuthority.AddPrecertificate
bytes der = 1
Next unused field number: 8
int64 regID = 2
optional issued = 7
int64 issuerNameID = 5
https://pkg.go.dev/github.com/letsencrypt/boulder/issuance#IssuerNameID
message
sa.proto:382Used in:
repeated string serials = 1
message
sa.proto:378Used in:
string serialTable = 1
message
sa.proto:292Used as request type in: StorageAuthority.DeactivateAuthorization2, StorageAuthority.GetAuthorization2, StorageAuthorityReadOnly.GetAuthorization2
int64 id = 1
message
sa.proto:288Used as response type in: StorageAuthority.GetOrderAuthorizations, StorageAuthority.GetValidAuthorizations2, StorageAuthority.GetValidOrderAuthorizations2, StorageAuthorityReadOnly.GetOrderAuthorizations, StorageAuthorityReadOnly.GetValidAuthorizations2, StorageAuthorityReadOnly.GetValidOrderAuthorizations2
repeated authzs = 2
message
sadb.proto:8Used internally for storage in the DB, not for RPCs. Invariant maintained by sa.NewOrderAndAuthzs: does not contain duplicates.
repeated int64 authzIDs = 1
message
sa.proto:164Used as request type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated identifiers = 5
optional window = 3
int64 limit = 4
message
sa.proto:155int64 registrationID = 1
Next unused field number: 5
optional identifier = 4
optional range = 3
Count authorizations that expire in this range.
message
sa.proto:179Used as response type in: StorageAuthority.FQDNSetExists, StorageAuthority.KeyBlocked, StorageAuthority.ReplacementOrderExists, StorageAuthorityReadOnly.FQDNSetExists, StorageAuthorityReadOnly.KeyBlocked, StorageAuthorityReadOnly.ReplacementOrderExists
bool exists = 1
message
sa.proto:173Used as request type in: StorageAuthority.FQDNSetExists, StorageAuthorityReadOnly.FQDNSetExists
repeated identifiers = 2
message
sa.proto:278int64 registrationID = 1
Next unused field number: 7
repeated identifiers = 6
optional validUntil = 4
string profile = 5
message
sa.proto:261Used as request type in: StorageAuthority.GetOrderAuthorizations, StorageAuthority.GetValidOrderAuthorizations2, StorageAuthorityReadOnly.GetOrderAuthorizations, StorageAuthorityReadOnly.GetValidOrderAuthorizations2
int64 id = 1
int64 acctID = 2
message
sa.proto:266Used as request type in: StorageAuthority.GetOrderForNames, StorageAuthorityReadOnly.GetOrderForNames
int64 acctID = 1
Next unused field number: 4
repeated identifiers = 3
message
sa.proto:476Used as request type in: StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetRateLimitOverride
int64 limitEnum = 1
string bucketKey = 2
message
sa.proto:395Used as request type in: StorageAuthority.GetRevokedCertsByShard, StorageAuthorityReadOnly.GetRevokedCertsByShard
int64 issuerNameID = 1
optional revokedBefore = 2
optional expiresAfter = 3
int64 shardIdx = 4
message
sa.proto:113Used as request type in: StorageAuthority.GetValidAuthorizations2, StorageAuthorityReadOnly.GetValidAuthorizations2
int64 registrationID = 1
Next unused field number: 7
repeated identifiers = 6
optional validUntil = 4
string profile = 5
message
sa.proto:427Used as response type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.GetPausedIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused, StorageAuthorityReadOnly.GetPausedIdentifiers
repeated identifiers = 1
message
sa.proto:336Used as response type in: StorageAuthorityAdmin.CreateIncident, StorageAuthorityAdmin.UpdateIncident
Used as field type in:
int64 id = 1
Next unused field number: 7
string serialTable = 2
string url = 3
optional renewBy = 6
bool enabled = 5
message
sa.proto:386Used as response type in: StorageAuthority.SerialsForIncident, StorageAuthorityReadOnly.SerialsForIncident
string serial = 1
Next unused field number: 6
int64 registrationID = 2
May be 0 (NULL)
int64 orderID = 3
May be 0 (NULL)
optional lastNoticeSent = 5
message
sa.proto:346Used as response type in: StorageAuthority.IncidentsForSerial, StorageAuthority.ListIncidents, StorageAuthorityReadOnly.IncidentsForSerial, StorageAuthorityReadOnly.ListIncidents
repeated incidents = 1
message
sa.proto:109Used as request type in: StorageAuthority.GetRegistrationByKey, StorageAuthorityReadOnly.GetRegistrationByKey
bytes jwk = 1
message
sa.proto:230NewAuthzRequest represents a request to create an authorization.
Used in:
optional identifier = 12
int64 registrationID = 3
optional expires = 9
repeated string challengeTypes = 10
string token = 11
message
sa.proto:210Used in:
int64 registrationID = 1
Next unused field number: 10
optional expires = 5
repeated identifiers = 9
repeated int64 v2Authorizations = 4
A list of already-existing authorization IDs that should be associated with the new Order object. This is for authorization reuse.
string certificateProfileName = 7
string replaces = 8
Replaces is the ARI certificate Id that this order replaces.
string replacesSerial = 6
ReplacesSerial is the serial number of the certificate that this order replaces.
message
sa.proto:206Used as request type in: StorageAuthority.GetOrder, StorageAuthority.SetOrderProcessing, StorageAuthorityReadOnly.GetOrder
int64 id = 1
message
sa.proto:431Used as request type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.PauseIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused
int64 registrationID = 1
repeated identifiers = 2
message
sa.proto:137Used in:
optional earliest = 3
optional latest = 4
message
sa.proto:446Used in: , ,
int64 limitEnum = 1
string bucketKey = 2
string comment = 3
optional period = 4
int64 count = 5
int64 burst = 6
message
sa.proto:481Used as response type in: StorageAuthority.GetEnabledRateLimitOverrides, StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetEnabledRateLimitOverrides, StorageAuthorityReadOnly.GetRateLimitOverride
optional override = 1
bool enabled = 2
optional updatedAt = 3
message
sa.proto:105Used as request type in: StorageAuthority.DeactivateRegistration, StorageAuthority.GetPausedIdentifiers, StorageAuthority.GetRegistration, StorageAuthority.GetSerialsByAccount, StorageAuthority.UnpauseAccount, StorageAuthorityReadOnly.GetPausedIdentifiers, StorageAuthorityReadOnly.GetRegistration, StorageAuthorityReadOnly.GetSerialsByAccount
int64 id = 1
message
sa.proto:402Used as response type in: StorageAuthority.GetRevocationStatus, StorageAuthorityReadOnly.GetRevocationStatus
int64 status = 1
int64 revokedReason = 2
optional revokedDate = 3
Unix timestamp (nanoseconds)
message
sa.proto:296Used as request type in: StorageAuthority.RevokeCertificate, StorageAuthority.UpdateRevokedCertificate
string serial = 1
Next unused field number: 10
int64 reason = 2
optional date = 8
optional backdate = 9
bytes response = 4
int64 issuerID = 6
int64 shardIdx = 7
message
sa.proto:332Used as request type in: StorageAuthority.GetSerialsByKey, StorageAuthority.KeyBlocked, StorageAuthorityReadOnly.GetSerialsByKey, StorageAuthorityReadOnly.KeyBlocked
bytes keyHash = 1
message
sa.proto:123Used as request type in: StorageAuthority.GetCertificate, StorageAuthority.GetCertificateStatus, StorageAuthority.GetLintPrecertificate, StorageAuthority.GetRevocationStatus, StorageAuthority.GetSerialMetadata, StorageAuthority.IncidentsForSerial, StorageAuthority.ReplacementOrderExists, StorageAuthorityReadOnly.GetCertificate, StorageAuthorityReadOnly.GetCertificateStatus, StorageAuthorityReadOnly.GetLintPrecertificate, StorageAuthorityReadOnly.GetRevocationStatus, StorageAuthorityReadOnly.GetSerialMetadata, StorageAuthorityReadOnly.IncidentsForSerial, StorageAuthorityReadOnly.ReplacementOrderExists
Used as response type in: StorageAuthority.GetSerialsByAccount, StorageAuthority.GetSerialsByKey, StorageAuthorityReadOnly.GetSerialsByAccount, StorageAuthorityReadOnly.GetSerialsByKey
string serial = 1
message
sa.proto:127Used as response type in: StorageAuthority.GetSerialMetadata, StorageAuthorityReadOnly.GetSerialMetadata
string serial = 1
Next unused field number: 7
int64 registrationID = 2
optional created = 5
optional expires = 6
message
sa.proto:350Used as request type in: StorageAuthority.SerialsForIncident, StorageAuthorityReadOnly.SerialsForIncident
string incidentTable = 1
message
sa.proto:149Used as response type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated timestamps = 2