package sa
Get desktop application:
View/edit binary Protocol Buffers messages
service StorageAuthority
sa.proto:46StorageAuthority provides full read/write access to the database.
Getters: this list must be identical to the StorageAuthorityReadOnly rpcs.
rpc FQDNSetExists (, )
sa.proto:50rpc GetAuthorization2 (, )
sa.proto:52rpc GetAuthorizations2 (, )
sa.proto:53rpc GetCertificate (, )
sa.proto:54rpc GetLintPrecertificate (, )
sa.proto:55rpc GetCertificateStatus (, )
sa.proto:56rpc GetMaxExpiration (, )
sa.proto:57rpc GetOrder (, )
sa.proto:58rpc GetOrderForNames (, )
sa.proto:59rpc GetRegistration (, )
sa.proto:60rpc GetRegistrationByKey (, )
sa.proto:61rpc GetRevocationStatus (, )
sa.proto:62rpc GetRevokedCerts (, stream )
sa.proto:63rpc GetRevokedCertsByShard (, stream )
sa.proto:64rpc GetSerialMetadata (, )
sa.proto:65rpc GetSerialsByAccount (, stream )
sa.proto:66rpc GetSerialsByKey (, stream )
sa.proto:67rpc GetValidAuthorizations2 (, )
sa.proto:68rpc IncidentsForSerial (, )
sa.proto:70rpc KeyBlocked (, )
sa.proto:71rpc ReplacementOrderExists (, )
sa.proto:72rpc SerialsForIncident (, stream )
sa.proto:73rpc CheckIdentifiersPaused (, )
sa.proto:74rpc GetPausedIdentifiers (, )
sa.proto:75rpc GetRateLimitOverride (, )
sa.proto:76rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:77rpc AddBlockedKey (, )
sa.proto:80Adders
message
sa.proto:340bytes keyHash = 1
Next unused field number: 7
optional added = 6
string source = 3
string comment = 4
int64 revokedBy = 5
rpc AddCertificate (, )
sa.proto:81rpc AddPrecertificate (, )
sa.proto:82rpc SetCertificateStatusReady (, )
sa.proto:83rpc AddSerial (, )
sa.proto:84message
sa.proto:188int64 regID = 1
Next unused field number: 7
string serial = 2
optional created = 5
optional expires = 6
rpc DeactivateAuthorization2 (, )
sa.proto:85rpc DeactivateRegistration (, )
sa.proto:86rpc FinalizeAuthorization2 (, )
sa.proto:87message
sa.proto:327int64 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:88message
sa.proto:287int64 id = 1
string certificateSerial = 2
rpc NewOrderAndAuthzs (, )
sa.proto:89message
sa.proto:265optional newOrder = 1
repeated newAuthzs = 2
rpc NewRegistration (, )
sa.proto:90rpc RevokeCertificate (, )
sa.proto:91rpc SetOrderError (, )
sa.proto:92message
sa.proto:270int64 id = 1
optional error = 2
rpc SetOrderProcessing (, )
sa.proto:93rpc UpdateRegistrationContact (, )
sa.proto:94message
sa.proto:439int64 registrationID = 1
repeated string contacts = 2
rpc UpdateRegistrationKey (, )
sa.proto:95message
sa.proto:444int64 registrationID = 1
bytes jwk = 2
rpc UpdateRevokedCertificate (, )
sa.proto:96rpc LeaseCRLShard (, )
sa.proto:97message
sa.proto:406int64 issuerNameID = 1
int64 minShardIdx = 2
int64 maxShardIdx = 3
optional until = 4
message
sa.proto:413int64 issuerNameID = 1
int64 shardIdx = 2
rpc UpdateCRLShard (, )
sa.proto:98message
sa.proto:418int64 issuerNameID = 1
int64 shardIdx = 2
optional thisUpdate = 3
optional nextUpdate = 4
rpc PauseIdentifiers (, )
sa.proto:99message
sa.proto:434int64 paused = 1
int64 repaused = 2
rpc UnpauseAccount (, )
sa.proto:100rpc AddRateLimitOverride (, )
sa.proto:101message
sa.proto:458optional override = 1
message
sa.proto:462bool inserted = 1
bool enabled = 2
rpc DisableRateLimitOverride (, )
sa.proto:102message
sa.proto:472int64 limitEnum = 1
string bucketKey = 2
rpc EnableRateLimitOverride (, )
sa.proto:103message
sa.proto:467int64 limitEnum = 1
string bucketKey = 2
StorageAuthorityReadOnly exposes only those SA methods which are read-only.
rpc FQDNSetExists (, )
sa.proto:15rpc GetAuthorization2 (, )
sa.proto:17rpc GetAuthorizations2 (, )
sa.proto:18rpc GetCertificate (, )
sa.proto:19rpc GetLintPrecertificate (, )
sa.proto:20rpc GetCertificateStatus (, )
sa.proto:21rpc GetMaxExpiration (, )
sa.proto:22rpc GetOrder (, )
sa.proto:23rpc GetOrderForNames (, )
sa.proto:24rpc GetRegistration (, )
sa.proto:25rpc GetRegistrationByKey (, )
sa.proto:26rpc GetRevocationStatus (, )
sa.proto:27rpc GetRevokedCerts (, stream )
sa.proto:28rpc GetRevokedCertsByShard (, stream )
sa.proto:29rpc GetSerialMetadata (, )
sa.proto:30rpc GetSerialsByAccount (, stream )
sa.proto:31rpc GetSerialsByKey (, stream )
sa.proto:32rpc GetValidAuthorizations2 (, )
sa.proto:33rpc IncidentsForSerial (, )
sa.proto:35rpc KeyBlocked (, )
sa.proto:36rpc ReplacementOrderExists (, )
sa.proto:37rpc SerialsForIncident (, stream )
sa.proto:38rpc CheckIdentifiersPaused (, )
sa.proto:39rpc GetPausedIdentifiers (, )
sa.proto:40rpc GetRateLimitOverride (, )
sa.proto:41rpc GetEnabledRateLimitOverrides (, stream )
sa.proto:42
message
sa.proto:198Used 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
bool ocspNotReady = 6
If this is set to true, the certificateStatus.status column will be set to "wait", which will cause us to serve internalError responses with OCSP is queried. This allows us to meet the BRs requirement: If the OCSP responder receives a request for the status of a certificate serial number that is “unused”, then ... the responder MUST NOT respond with a “good” status for such requests. Paraphrasing, a certificate serial number is unused if neither a Certificate nor a Precertificate has been issued with it. So when we write a linting certificate to the precertificates table, we want to make sure we never give a "good" response for that serial until the precertificate is actually issued.
message
sa.proto:114string id = 1
message
sa.proto:310Used as request type in: StorageAuthority.DeactivateAuthorization2, StorageAuthority.GetAuthorization2, StorageAuthorityReadOnly.GetAuthorization2
int64 id = 1
message
sa.proto:306repeated string ids = 1
message
sa.proto:302Used as response type in: StorageAuthority.GetAuthorizations2, StorageAuthority.GetValidAuthorizations2, StorageAuthority.GetValidOrderAuthorizations2, StorageAuthorityReadOnly.GetAuthorizations2, StorageAuthorityReadOnly.GetValidAuthorizations2, StorageAuthorityReadOnly.GetValidOrderAuthorizations2
repeated authzs = 2
message
sa.proto:150Used as response type in: StorageAuthority.CountInvalidAuthorizations2, StorageAuthority.CountPendingAuthorizations2, StorageAuthority.UnpauseAccount, StorageAuthorityReadOnly.CountInvalidAuthorizations2, StorageAuthorityReadOnly.CountPendingAuthorizations2
int64 count = 1
message
sa.proto:169Used as request type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated identifiers = 5
optional window = 3
int64 limit = 4
message
sa.proto:160Used as request type in: StorageAuthority.CountInvalidAuthorizations2, StorageAuthorityReadOnly.CountInvalidAuthorizations2
int64 registrationID = 1
Next unused field number: 5
optional identifier = 4
optional range = 3
Count authorizations that expire in this range.
message
sa.proto:184Used as response type in: StorageAuthority.FQDNSetExists, StorageAuthority.KeyBlocked, StorageAuthority.ReplacementOrderExists, StorageAuthorityReadOnly.FQDNSetExists, StorageAuthorityReadOnly.KeyBlocked, StorageAuthorityReadOnly.ReplacementOrderExists
bool exists = 1
message
sa.proto:178Used as request type in: StorageAuthority.FQDNSetExists, StorageAuthorityReadOnly.FQDNSetExists
repeated identifiers = 2
message
sa.proto:292Used as request type in: StorageAuthority.GetAuthorizations2, StorageAuthorityReadOnly.GetAuthorizations2
int64 registrationID = 1
Next unused field number: 7
repeated identifiers = 6
optional validUntil = 4
string profile = 5
message
sa.proto:280Used as request type in: StorageAuthority.GetOrderForNames, StorageAuthorityReadOnly.GetOrderForNames
int64 acctID = 1
Next unused field number: 4
repeated identifiers = 3
message
sa.proto:477Used as request type in: StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetRateLimitOverride
int64 limitEnum = 1
string bucketKey = 2
message
sa.proto:381Used as request type in: StorageAuthority.GetRevokedCertsByShard, StorageAuthorityReadOnly.GetRevokedCertsByShard
int64 issuerNameID = 1
optional revokedBefore = 2
optional expiresAfter = 3
int64 shardIdx = 4
message
sa.proto:388Used as request type in: StorageAuthority.GetRevokedCerts, StorageAuthorityReadOnly.GetRevokedCerts
int64 issuerNameID = 1
Next unused field number: 9
optional expiresAfter = 6
inclusive
optional expiresBefore = 7
exclusive
optional revokedBefore = 8
message
sa.proto:118Used 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:275Used as request type in: StorageAuthority.GetValidOrderAuthorizations2, StorageAuthorityReadOnly.GetValidOrderAuthorizations2
int64 id = 1
int64 acctID = 2
message
sa.proto:425Used as response type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.GetPausedIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused, StorageAuthorityReadOnly.GetPausedIdentifiers
repeated identifiers = 1
message
sa.proto:354Used in:
int64 id = 1
Next unused field number: 7
string serialTable = 2
string url = 3
optional renewBy = 6
bool enabled = 5
message
sa.proto:372Used 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:364Used as response type in: StorageAuthority.IncidentsForSerial, StorageAuthorityReadOnly.IncidentsForSerial
repeated incidents = 1
message
sa.proto:110Used as request type in: StorageAuthority.GetRegistrationByKey, StorageAuthorityReadOnly.GetRegistrationByKey
bytes jwk = 1
message
sa.proto:249NewAuthzRequest starts with all the same fields as corepb.Authorization, because it is replacing that type in NewOrderAndAuthzsRequest, and then improves from there.
Used in:
optional identifier = 12
int64 registrationID = 3
optional expires = 9
repeated string challengeTypes = 10
string token = 11
message
sa.proto:229Used in:
int64 registrationID = 1
Next unused field number: 10
optional expires = 5
repeated identifiers = 9
repeated int64 v2Authorizations = 4
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:225Used as request type in: StorageAuthority.GetOrder, StorageAuthority.SetOrderProcessing, StorageAuthorityReadOnly.GetOrder
int64 id = 1
message
sa.proto:429Used as request type in: StorageAuthority.CheckIdentifiersPaused, StorageAuthority.PauseIdentifiers, StorageAuthorityReadOnly.CheckIdentifiersPaused
int64 registrationID = 1
repeated identifiers = 2
message
sa.proto:142Used in:
optional earliest = 3
optional latest = 4
message
sa.proto:449Used as response type in: StorageAuthority.GetEnabledRateLimitOverrides, StorageAuthorityReadOnly.GetEnabledRateLimitOverrides
Used as field type in: ,
int64 limitEnum = 1
string bucketKey = 2
string comment = 3
optional period = 4
int64 count = 5
int64 burst = 6
message
sa.proto:482Used as response type in: StorageAuthority.GetRateLimitOverride, StorageAuthorityReadOnly.GetRateLimitOverride
optional override = 1
bool enabled = 2
optional updatedAt = 3
message
sa.proto:106Used as request type in: StorageAuthority.CountPendingAuthorizations2, StorageAuthority.DeactivateRegistration, StorageAuthority.GetPausedIdentifiers, StorageAuthority.GetRegistration, StorageAuthority.GetSerialsByAccount, StorageAuthority.UnpauseAccount, StorageAuthorityReadOnly.CountPendingAuthorizations2, StorageAuthorityReadOnly.GetPausedIdentifiers, StorageAuthorityReadOnly.GetRegistration, StorageAuthorityReadOnly.GetSerialsByAccount
int64 id = 1
message
sa.proto:400Used as response type in: StorageAuthority.GetRevocationStatus, StorageAuthorityReadOnly.GetRevocationStatus
int64 status = 1
int64 revokedReason = 2
optional revokedDate = 3
Unix timestamp (nanoseconds)
message
sa.proto:314Used 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:350Used as request type in: StorageAuthority.GetSerialsByKey, StorageAuthority.KeyBlocked, StorageAuthorityReadOnly.GetSerialsByKey, StorageAuthorityReadOnly.KeyBlocked
bytes keyHash = 1
message
sa.proto:128Used as request type in: StorageAuthority.GetCertificate, StorageAuthority.GetCertificateStatus, StorageAuthority.GetLintPrecertificate, StorageAuthority.GetRevocationStatus, StorageAuthority.GetSerialMetadata, StorageAuthority.IncidentsForSerial, StorageAuthority.ReplacementOrderExists, StorageAuthority.SetCertificateStatusReady, 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:132Used 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:368Used as request type in: StorageAuthority.SerialsForIncident, StorageAuthorityReadOnly.SerialsForIncident
string incidentTable = 1
message
sa.proto:154Used as response type in: StorageAuthority.FQDNSetTimestampsForWindow, StorageAuthorityReadOnly.FQDNSetTimestampsForWindow
repeated timestamps = 2