1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
package crypto
// SignHandleBuilder allows to configure a sign handle
// to sign data with OpenPGP.
type SignHandleBuilder struct {
handle *signatureHandle
defaultClock Clock
err error
}
func newSignHandleBuilder(profile SignProfile, clock Clock) *SignHandleBuilder {
return &SignHandleBuilder{
handle: defaultSignatureHandle(profile, clock),
defaultClock: clock,
}
}
// SigningKey sets the signing key that is used to create signature of the message.
func (shb *SignHandleBuilder) SigningKey(key *Key) *SignHandleBuilder {
var err error
if shb.handle.SignKeyRing == nil {
shb.handle.SignKeyRing, err = NewKeyRing(key)
} else {
err = shb.handle.SignKeyRing.AddKey(key)
}
shb.err = err
return shb
}
// SigningKeys sets the signing keys that are used to create signature of the message.
func (shb *SignHandleBuilder) SigningKeys(signingKeys *KeyRing) *SignHandleBuilder {
shb.handle.SignKeyRing = signingKeys
return shb
}
// SigningContext provides a signing context for the signature in the message.
// Triggers that each signature includes the sining context.
func (shb *SignHandleBuilder) SigningContext(signingContext *SigningContext) *SignHandleBuilder {
shb.handle.SignContext = signingContext
return shb
}
// Detached indicates if a detached signature should be produced.
// The sign output will be a detached signature message without the data included.
func (shb *SignHandleBuilder) Detached() *SignHandleBuilder {
shb.handle.Detached = true
return shb
}
// ArmorHeader indicates that the produced signature should be armored
// with the given version and comment as header.
// Note that this option only affects the method SignHandle.SigningWriter
// and the headers in SignHandle.SignCleartext.
func (shb *SignHandleBuilder) ArmorHeader(version, comment string) *SignHandleBuilder {
if shb.handle.ArmorHeaders == nil {
shb.handle.ArmorHeaders = make(map[string]string)
}
shb.handle.ArmorHeaders["Version"] = version
shb.handle.ArmorHeaders["Comment"] = comment
return shb
}
// Utf8 indicates if the plaintext should be signed with a text type
// signature. If set, the plaintext is signed after
// canonicalising the line endings.
func (shb *SignHandleBuilder) Utf8() *SignHandleBuilder {
shb.handle.IsUTF8 = true
return shb
}
// SignTime sets the internal clock to always return
// the supplied unix time for signing instead of the device time.
func (shb *SignHandleBuilder) SignTime(unixTime int64) *SignHandleBuilder {
shb.handle.clock = NewConstantClock(unixTime)
return shb
}
// New creates a SignHandle and checks that the given
// combination of parameters is valid. If the parameters are invalid
// an error is returned.
func (shb *SignHandleBuilder) New() (PGPSign, error) {
if shb.err != nil {
return nil, shb.err
}
shb.err = shb.handle.validate()
if shb.err != nil {
return nil, shb.err
}
handle := shb.handle
shb.handle = defaultSignatureHandle(shb.handle.profile, shb.defaultClock)
return handle, nil
}
// Error returns any errors that occurred within the builder.
func (shb *SignHandleBuilder) Error() error {
return shb.err
}
|