Skip to content
  • Eric Blake's avatar
    1b5c15ce
    nbd/client: Add hint when TLS is missing · 1b5c15ce
    Eric Blake authored
    
    
    I received an off-list report of failure to connect to an NBD server
    expecting an x509 certificate, when the client was attempting something
    similar to this command line:
    
    $ ./x86_64-softmmu/qemu-system-x86_64 -name 'blah' -machine q35 -nodefaults \
      -object tls-creds-x509,id=tls0,endpoint=client,dir=$path_to_certs \
      -device virtio-scsi-pci,id=virtio_scsi_pci0,bus=pcie.0,addr=0x6 \
      -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0 \
      -device scsi-hd,id=image1,drive=drive_image1,bootindex=0
    qemu-system-x86_64: -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0: TLS negotiation required before option 7 (go)
    server reported: Option 0x7 not permitted before TLS
    
    The problem?  As specified, -drive is trying to pass tls-creds to the
    raw format driver instead of the nbd protocol driver, but before we
    get to the point where we can detect that raw doesn't know what to do
    with tls-creds, the nbd driver has already failed because the server
    complained.  The fix to the broken command line?  Pass
    '...,file.tls-creds=tls0' to ensure the tls-creds option is handed to
    nbd, not raw.  But since the error message was rather cryptic, I'm
    trying to improve the error message.
    
    With this patch, the error message adds a line:
    
    qemu-system-x86_64: -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0: TLS negotiation required before option 7 (go)
    Did you forget a valid tls-creds?
    server reported: Option 0x7 not permitted before TLS
    
    And with luck, someone grepping for that error message will find this
    commit message and figure out their command line mistake.  Sadly, the
    only mention of file.tls-creds in our docs relates to an --image-opts
    use of PSK encryption with qemu-img as the client, rather than x509
    certificate encryption with qemu-kvm as the client.
    
    CC: Tingting Mao <timao@redhat.com>
    CC: Daniel P. Berrangé <berrange@redhat.com>
    Signed-off-by: default avatarEric Blake <eblake@redhat.com>
    Message-Id: <20190907172055.26870-1-eblake@redhat.com>
    [eblake: squash in iotest 233 fix]
    Reviewed-by: default avatarDaniel P. Berrangé <berrange@redhat.com>
    1b5c15ce
    nbd/client: Add hint when TLS is missing
    Eric Blake authored
    
    
    I received an off-list report of failure to connect to an NBD server
    expecting an x509 certificate, when the client was attempting something
    similar to this command line:
    
    $ ./x86_64-softmmu/qemu-system-x86_64 -name 'blah' -machine q35 -nodefaults \
      -object tls-creds-x509,id=tls0,endpoint=client,dir=$path_to_certs \
      -device virtio-scsi-pci,id=virtio_scsi_pci0,bus=pcie.0,addr=0x6 \
      -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0 \
      -device scsi-hd,id=image1,drive=drive_image1,bootindex=0
    qemu-system-x86_64: -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0: TLS negotiation required before option 7 (go)
    server reported: Option 0x7 not permitted before TLS
    
    The problem?  As specified, -drive is trying to pass tls-creds to the
    raw format driver instead of the nbd protocol driver, but before we
    get to the point where we can detect that raw doesn't know what to do
    with tls-creds, the nbd driver has already failed because the server
    complained.  The fix to the broken command line?  Pass
    '...,file.tls-creds=tls0' to ensure the tls-creds option is handed to
    nbd, not raw.  But since the error message was rather cryptic, I'm
    trying to improve the error message.
    
    With this patch, the error message adds a line:
    
    qemu-system-x86_64: -drive id=drive_image1,if=none,snapshot=off,aio=threads,cache=none,format=raw,file=nbd:localhost:9000,werror=stop,rerror=stop,tls-creds=tls0: TLS negotiation required before option 7 (go)
    Did you forget a valid tls-creds?
    server reported: Option 0x7 not permitted before TLS
    
    And with luck, someone grepping for that error message will find this
    commit message and figure out their command line mistake.  Sadly, the
    only mention of file.tls-creds in our docs relates to an --image-opts
    use of PSK encryption with qemu-img as the client, rather than x509
    certificate encryption with qemu-kvm as the client.
    
    CC: Tingting Mao <timao@redhat.com>
    CC: Daniel P. Berrangé <berrange@redhat.com>
    Signed-off-by: default avatarEric Blake <eblake@redhat.com>
    Message-Id: <20190907172055.26870-1-eblake@redhat.com>
    [eblake: squash in iotest 233 fix]
    Reviewed-by: default avatarDaniel P. Berrangé <berrange@redhat.com>
Loading