mirror of
https://git.yoctoproject.org/poky
synced 2026-05-09 17:39:31 +00:00
Stefan Herbrechtsmeier
3e543e8eaa
The fetch data class already expands the type, host, path, user, pswd and parm variables. The fetcher classes already expand the localfile variable. The getVar function expands the returned string per default. Remove unnecessary expand function calls to simplify the code. (Bitbake rev: 1b1eb037b861fbf20491ac17e519e9eaf232b858) Signed-off-by: Stefan Herbrechtsmeier <stefan.herbrechtsmeier@weidmueller.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
113 lines
3.4 KiB
Python
113 lines
3.4 KiB
Python
"""
|
|
BitBake SFTP Fetch implementation
|
|
|
|
Class for fetching files via SFTP. It tries to adhere to the (now
|
|
expired) IETF Internet Draft for "Uniform Resource Identifier (URI)
|
|
Scheme for Secure File Transfer Protocol (SFTP) and Secure Shell
|
|
(SSH)" (SECSH URI).
|
|
|
|
It uses SFTP (as to adhere to the SECSH URI specification). It only
|
|
supports key based authentication, not password. This class, unlike
|
|
the SSH fetcher, does not support fetching a directory tree from the
|
|
remote.
|
|
|
|
http://tools.ietf.org/html/draft-ietf-secsh-scp-sftp-ssh-uri-04
|
|
https://www.iana.org/assignments/uri-schemes/prov/sftp
|
|
https://tools.ietf.org/html/draft-ietf-secsh-filexfer-13
|
|
|
|
Please note that '/' is used as host path seperator, and not ":"
|
|
as you may be used to from the scp/sftp commands. You can use a
|
|
~ (tilde) to specify a path relative to your home directory.
|
|
(The /~user/ syntax, for specyfing a path relative to another
|
|
user's home directory is not supported.) Note that the tilde must
|
|
still follow the host path seperator ("/"). See exampels below.
|
|
|
|
Example SRC_URIs:
|
|
|
|
SRC_URI = "sftp://host.example.com/dir/path.file.txt"
|
|
|
|
A path relative to your home directory.
|
|
|
|
SRC_URI = "sftp://host.example.com/~/dir/path.file.txt"
|
|
|
|
You can also specify a username (specyfing password in the
|
|
URI is not supported, use SSH keys to authenticate):
|
|
|
|
SRC_URI = "sftp://user@host.example.com/dir/path.file.txt"
|
|
|
|
"""
|
|
|
|
# Copyright (C) 2013, Olof Johansson <olof.johansson@axis.com>
|
|
#
|
|
# Based in part on bb.fetch2.wget:
|
|
# Copyright (C) 2003, 2004 Chris Larson
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# Based on functions from the base bb module, Copyright 2003 Holger Schurig
|
|
|
|
import os
|
|
import bb
|
|
import urllib.request, urllib.parse, urllib.error
|
|
from bb.fetch2 import URI
|
|
from bb.fetch2 import FetchMethod
|
|
from bb.fetch2 import runfetchcmd
|
|
|
|
class SFTP(FetchMethod):
|
|
"""Class to fetch urls via 'sftp'"""
|
|
|
|
def supports(self, ud, d):
|
|
"""
|
|
Check to see if a given url can be fetched with sftp.
|
|
"""
|
|
return ud.type in ['sftp']
|
|
|
|
def recommends_checksum(self, urldata):
|
|
return True
|
|
|
|
def urldata_init(self, ud, d):
|
|
if 'protocol' in ud.parm and ud.parm['protocol'] == 'git':
|
|
raise bb.fetch2.ParameterError(
|
|
"Invalid protocol - if you wish to fetch from a " +
|
|
"git repository using ssh, you need to use the " +
|
|
"git:// prefix with protocol=ssh", ud.url)
|
|
|
|
if 'downloadfilename' in ud.parm:
|
|
ud.basename = ud.parm['downloadfilename']
|
|
else:
|
|
ud.basename = os.path.basename(ud.path)
|
|
|
|
ud.localfile = urllib.parse.unquote(ud.basename)
|
|
|
|
def download(self, ud, d):
|
|
"""Fetch urls"""
|
|
|
|
urlo = URI(ud.url)
|
|
basecmd = 'sftp -oBatchMode=yes'
|
|
port = ''
|
|
if urlo.port:
|
|
port = '-P %d' % urlo.port
|
|
urlo.port = None
|
|
|
|
dldir = d.getVar('DL_DIR')
|
|
lpath = os.path.join(dldir, ud.localfile)
|
|
|
|
user = ''
|
|
if urlo.userinfo:
|
|
user = urlo.userinfo + '@'
|
|
|
|
path = urlo.path
|
|
|
|
# Supoprt URIs relative to the user's home directory, with
|
|
# the tilde syntax. (E.g. <sftp://example.com/~/foo.diff>).
|
|
if path[:3] == '/~/':
|
|
path = path[3:]
|
|
|
|
remote = '"%s%s:%s"' % (user, urlo.hostname, path)
|
|
|
|
cmd = '%s %s %s %s' % (basecmd, port, remote, lpath)
|
|
|
|
bb.fetch2.check_network_access(d, cmd, ud.url)
|
|
runfetchcmd(cmd, d)
|
|
return True
|