package sa
Get desktop application:
View/edit binary Protocol Buffers messages
service StorageAuthority
sa.proto:42StorageAuthority provides full read/write access to the database.
rpc AddBlockedKey (, )
sa.proto:72Adders
message
sa.proto:321bytes keyHash = 1
Next unused field number: 7
optional added = 6
string source = 3
string comment = 4
int64 revokedBy = 5
rpc AddCertificate (, )
sa.proto:73rpc AddPrecertificate (, )
sa.proto:74rpc AddRateLimitOverride (, )
sa.proto:92message
sa.proto:448optional override = 1
bool force = 2
message
sa.proto:453bool inserted = 1
bool enabled = 2
optional existing = 3
rpc AddSerial (, )
sa.proto:75message
sa.proto:182int64 regID = 1
Next unused field number: 7
string serial = 2
optional created = 5
optional expires = 6
rpc CheckIdentifiersPaused (, )
sa.proto:66rpc DeactivateAuthorization2 (, )
sa.proto:76rpc DeactivateRegistration (, )
sa.proto:77rpc DisableRateLimitOverride (, )
sa.proto:93message
sa.proto:464int64 limitEnum = 1
string bucketKey = 2
rpc EnableRateLimitOverride (, )
sa.proto:94message
sa.proto:459int64 limitEnum = 1
string bucketKey = 2
rpc FQDNSetExists (, )
sa.proto:44Getters: this list must be identical to the StorageAuthorityReadOnly rpcs.
rpc FinalizeAuthorization2 (, )
sa.proto:78message
sa.proto:308int64 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:79message
sa.proto:272int64 id = 1
string certificateSerial = 2
rpc GetAuthorization2 (, )
sa.proto:46rpc GetCertificate (, )
sa.proto:47rpc GetCertificateStatus (, )
sa.proto:49rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:69rpc GetLintPrecertificate (, )
sa.proto:48rpc GetOrder (, )
sa.proto:50rpc GetOrderAuthorizations (, )
sa.proto:60rpc GetOrderForNames (, )
sa.proto:51rpc GetPausedIdentifiers (, )
sa.proto:67rpc GetRateLimitOverride (, )
sa.proto:68rpc GetRegistration (, )
sa.proto:52rpc GetRegistrationByKey (, )
sa.proto:53rpc GetRevokedCertsByShard (, stream )
sa.proto:54rpc GetSerialMetadata (, )
sa.proto:55rpc GetSerialsByAccount (, stream )
sa.proto:56rpc GetSerialsByKey (, stream )
sa.proto:57rpc GetValidAuthorizations2 (, )
sa.proto:58rpc IncidentsForSerial (, )
sa.proto:61rpc KeyBlocked (, )
sa.proto:62rpc LeaseCRLShard (, )
sa.proto:88message
sa.proto:401int64 issuerNameID = 1
int64 minShardIdx = 2
int64 maxShardIdx = 3
optional until = 4
message
sa.proto:408int64 issuerNameID = 1
int64 shardIdx = 2
rpc ListIncidents (, )
sa.proto:63rpc NewOrderAndAuthzs (, )
sa.proto:80message
sa.proto:245optional 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:81rpc PauseIdentifiers (, )
sa.proto:90message
sa.proto:429int64 paused = 1
int64 repaused = 2
rpc ReplacementOrderExists (, )
sa.proto:64rpc RevokeCertificate (, )
sa.proto:82rpc SerialsForIncident (, stream )
sa.proto:65rpc SetAuthzProcessing (, )
sa.proto:83rpc SetOrderError (, )
sa.proto:84message
sa.proto:255int64 id = 1
optional error = 2
rpc SetOrderProcessing (, )
sa.proto:85rpc UnpauseAccount (, )
sa.proto:91message
sa.proto:144int64 count = 1
rpc UpdateCRLShard (, )
sa.proto:89message
sa.proto:413int64 issuerNameID = 1
int64 shardIdx = 2
optional thisUpdate = 3
optional nextUpdate = 4
rpc UpdateRegistrationKey (, )
sa.proto:86message
sa.proto:434int64 registrationID = 1
bytes jwk = 2
rpc UpdateRevokedCertificate (, )
sa.proto:87
service StorageAuthorityAdmin
sa.proto:98StorageAuthorityAdmin exposes those SA methods exclusive to the admin tool.
rpc AddSerialsToIncident (stream , )
sa.proto:101message
sa.proto:370oneof payload
metadata = 1
batch = 2
rpc CreateIncident (, )
sa.proto:99message
sa.proto:353string serialTable = 1
string url = 2
optional renewBy = 3
rpc UpdateIncident (, )
sa.proto:100message
sa.proto:363UpdateIncidentRequest 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:35rpc FQDNSetExists (, )
sa.proto:13rpc GetAuthorization2 (, )
sa.proto:15rpc GetCertificate (, )
sa.proto:16rpc GetCertificateStatus (, )
sa.proto:18rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:38rpc GetLintPrecertificate (, )
sa.proto:17rpc GetOrder (, )
sa.proto:19rpc GetOrderAuthorizations (, )
sa.proto:29rpc GetOrderForNames (, )
sa.proto:20rpc GetPausedIdentifiers (, )
sa.proto:36rpc GetRateLimitOverride (, )
sa.proto:37rpc GetRegistration (, )
sa.proto:21rpc GetRegistrationByKey (, )
sa.proto:22rpc GetRevokedCertsByShard (, stream )
sa.proto:23rpc GetSerialMetadata (, )
sa.proto:24rpc GetSerialsByAccount (, stream )
sa.proto:25rpc GetSerialsByKey (, stream )
sa.proto:26rpc GetValidAuthorizations2 (, )
sa.proto:27rpc IncidentsForSerial (, )
sa.proto:30rpc KeyBlocked (, )
sa.proto:31rpc ListIncidents (, )
sa.proto:32rpc ReplacementOrderExists (, )
sa.proto:33rpc SerialsForIncident (, stream )
sa.proto:34
message
sa.proto:192Used 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:381Used in:
repeated string serials = 1
message
sa.proto:377Used in:
string serialTable = 1
message
sa.proto:291Used as request type in: StorageAuthority.DeactivateAuthorization2, StorageAuthority.GetAuthorization2, StorageAuthority.SetAuthzProcessing, StorageAuthorityReadOnly.GetAuthorization2
int64 id = 1
message
sa.proto:287Used 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:163Used as request type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated identifiers = 5
optional window = 3
int64 limit = 4
message
sa.proto:154int64 registrationID = 1
Next unused field number: 5
optional identifier = 4
optional range = 3
Count authorizations that expire in this range.
message
sa.proto:178Used as response type in: StorageAuthority.FQDNSetExists, StorageAuthority.KeyBlocked, StorageAuthority.ReplacementOrderExists, StorageAuthorityReadOnly.FQDNSetExists, StorageAuthorityReadOnly.KeyBlocked, StorageAuthorityReadOnly.ReplacementOrderExists
bool exists = 1
message
sa.proto:172Used as request type in: StorageAuthority.FQDNSetExists, StorageAuthorityReadOnly.FQDNSetExists
repeated identifiers = 2
message
sa.proto:277int64 registrationID = 1
Next unused field number: 7
repeated identifiers = 6
optional validUntil = 4
string profile = 5
message
sa.proto:260Used as request type in: StorageAuthority.GetOrderAuthorizations, StorageAuthority.GetValidOrderAuthorizations2, StorageAuthorityReadOnly.GetOrderAuthorizations, StorageAuthorityReadOnly.GetValidOrderAuthorizations2
int64 id = 1
int64 acctID = 2
message
sa.proto:265Used as request type in: StorageAuthority.GetOrderForNames, StorageAuthorityReadOnly.GetOrderForNames
int64 acctID = 1
Next unused field number: 4
repeated identifiers = 3
message
sa.proto:469Used as request type in: StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetRateLimitOverride
int64 limitEnum = 1
string bucketKey = 2
message
sa.proto:394Used as request type in: StorageAuthority.GetRevokedCertsByShard, StorageAuthorityReadOnly.GetRevokedCertsByShard
int64 issuerNameID = 1
optional revokedBefore = 2
optional expiresAfter = 3
int64 shardIdx = 4
message
sa.proto:112Used 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:420Used as response type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.GetPausedIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused, StorageAuthorityReadOnly.GetPausedIdentifiers
repeated identifiers = 1
message
sa.proto:335Used 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:385Used 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:345Used as response type in: StorageAuthority.IncidentsForSerial, StorageAuthority.ListIncidents, StorageAuthorityReadOnly.IncidentsForSerial, StorageAuthorityReadOnly.ListIncidents
repeated incidents = 1
message
sa.proto:108Used as request type in: StorageAuthority.GetRegistrationByKey, StorageAuthorityReadOnly.GetRegistrationByKey
bytes jwk = 1
message
sa.proto:229NewAuthzRequest 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:209Used 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:205Used as request type in: StorageAuthority.GetOrder, StorageAuthority.SetOrderProcessing, StorageAuthorityReadOnly.GetOrder
int64 id = 1
message
sa.proto:424Used as request type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.PauseIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused
int64 registrationID = 1
repeated identifiers = 2
message
sa.proto:136Used in:
optional earliest = 3
optional latest = 4
message
sa.proto:439Used in: , ,
int64 limitEnum = 1
string bucketKey = 2
string comment = 3
optional period = 4
int64 count = 5
int64 burst = 6
message
sa.proto:474Used as response type in: StorageAuthority.GetEnabledRateLimitOverrides, StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetEnabledRateLimitOverrides, StorageAuthorityReadOnly.GetRateLimitOverride
optional override = 1
bool enabled = 2
optional updatedAt = 3
message
sa.proto:104Used 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:295Used 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:331Used as request type in: StorageAuthority.GetSerialsByKey, StorageAuthority.KeyBlocked, StorageAuthorityReadOnly.GetSerialsByKey, StorageAuthorityReadOnly.KeyBlocked
bytes keyHash = 1
message
sa.proto:122Used as request type in: StorageAuthority.GetCertificate, StorageAuthority.GetCertificateStatus, StorageAuthority.GetLintPrecertificate, StorageAuthority.GetSerialMetadata, StorageAuthority.IncidentsForSerial, StorageAuthority.ReplacementOrderExists, StorageAuthorityReadOnly.GetCertificate, StorageAuthorityReadOnly.GetCertificateStatus, StorageAuthorityReadOnly.GetLintPrecertificate, 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:126Used 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:349Used as request type in: StorageAuthority.SerialsForIncident, StorageAuthorityReadOnly.SerialsForIncident
string incidentTable = 1
message
sa.proto:148Used as response type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated timestamps = 2