mirror of
https://git.libssh.org/projects/libssh.git
synced 2026-02-11 10:40:27 +09:00
first import
git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@1 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
426
doc/draft-ietf-secsh-scp-sftp-ssh-uri-00.txt
Normal file
426
doc/draft-ietf-secsh-scp-sftp-ssh-uri-00.txt
Normal file
@@ -0,0 +1,426 @@
|
||||
Network Working Group S. Suehring
|
||||
Internet-Draft Sentry Insurance
|
||||
Expires February 8, 2004 J. Salowey
|
||||
Cisco Systems
|
||||
August 8, 2003
|
||||
|
||||
|
||||
SCP/SFTP/SSH URI Format
|
||||
draft-ietf-secsh-scp-sftp-ssh-uri-00.txt
|
||||
|
||||
Status of this Memo
|
||||
|
||||
This document is an Internet-Draft and is subject to all provisions
|
||||
of Section 10 of RFC2026.
|
||||
|
||||
Internet-Drafts are working documents of the Internet Engineering
|
||||
Task Force (IETF), its areas, and its working groups. Note that
|
||||
other groups may also distribute working documents as
|
||||
Internet-Drafts.
|
||||
|
||||
Internet-Drafts are draft documents valid for a maximum of six
|
||||
months and may be updated, replaced, or obsoleted by other
|
||||
documents at any time. It is inappropriate to use Internet-Drafts
|
||||
as reference material or to cite them other than as "work in
|
||||
progress."
|
||||
|
||||
The list of current Internet-Drafts can be accessed at
|
||||
http://www.ietf.org/1id-abstracts.html
|
||||
|
||||
The list of Internet-Draft Shadow Directories can be accessed at
|
||||
http://www.ietf.org/shadow.html
|
||||
|
||||
This Internet Draft will expire on February 8, 2004.
|
||||
|
||||
|
||||
Copyright Notice
|
||||
|
||||
Copyright (C) The Internet Society (2003). All Rights Reserved.
|
||||
|
||||
|
||||
Abstract
|
||||
|
||||
This document describes the Uniform Resource Identifiers used to
|
||||
locate resources for the SCP, SFTP, and SSH protocols. The document
|
||||
describes the generic syntax involved in URI definitions as well as
|
||||
specific definitions for each protocol. These specific definitions
|
||||
may include user credentials such as username and password and also
|
||||
may include other parameters such as fingerprint. In addition,
|
||||
security considerations and examples are also provided within this
|
||||
document.
|
||||
|
||||
|
||||
General Syntax
|
||||
|
||||
The URI for each protocol shall consist of the scheme and the scheme
|
||||
specific portion separated by a colon ":", as discussed in RFC 2396
|
||||
[1]. This specification shall adopt the definitions "port", "host",
|
||||
"scheme", "userinfo", and "authority" from RFC 2396.
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 1]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
SSH URI
|
||||
|
||||
The SSH scheme shall consist of the protocol acronym followed by a
|
||||
colon ":" and a double slash "//" in accordance with RFC 2718 [2].
|
||||
|
||||
The first component of the scheme specific portion MAY include
|
||||
credentials (userinfo) consisting of a username and optionally also
|
||||
including a password. Including the password in the URL is NOT
|
||||
RECOMMENDED. The username and password components are separated by
|
||||
a single colon ":".
|
||||
|
||||
Following the userinfo, if present, the at-sign "@" shall
|
||||
precede the authority section of the URI. Optionally, the
|
||||
authority section MAY also include the port preceded by a colon ":".
|
||||
If the port is not included, port 22 is assumed. Following the port
|
||||
additional parameters may be specified. These parameters are
|
||||
defined in the connection parameters section.
|
||||
|
||||
ssh_URI = "ssh://" [ userinfo "@" ] host [ ":" port ]
|
||||
[;conn-parameter=value]
|
||||
|
||||
SCP and SFTP URI
|
||||
|
||||
For SCP and SFTP, the scheme portion (scp: or sftp:) is followed by
|
||||
a double slash "//".
|
||||
|
||||
Both SCP and SFTP URLs are terminated by a single slash "/" followed
|
||||
by the path information to the requested resource.
|
||||
|
||||
The first component of the scheme specific portion MAY include
|
||||
credentials (userinfo) consisting of a username and optionally also
|
||||
including a password. Including the password in the URL is NOT
|
||||
RECOMMENDED. The username and password components are separated by
|
||||
a single colon ":".
|
||||
|
||||
Following the userinfo, if present, the at-sign "@" shall precede
|
||||
the authority section of the URL. Optionally, the authority section
|
||||
MAY also include the port preceded by a colon ":". If the port is
|
||||
not included, port 22 is assumed. Following the port additional
|
||||
parameters may be specified. These parameters are defined in the
|
||||
connection parameters section.
|
||||
|
||||
scp_URI = "scp://" [ userinfo "@" ] host [ ":" port ]
|
||||
[ ; parameter = value ] [ abs_path ]
|
||||
|
||||
Following the port additional parameters may be specified. These
|
||||
parameters are defined in the connection parameters section.
|
||||
Following the path additional sftp specific parameters may be
|
||||
specified.
|
||||
|
||||
sftp_URI = "sftp://" [ userinfo "@" ] host [ ":" port ]
|
||||
[;conn-parameter=value] [ abs_path ] [;sftp-parameter=value]
|
||||
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 2]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
|
||||
Parameters
|
||||
|
||||
SSH connection parameters
|
||||
|
||||
The following parameters are associated with an SSH connection and
|
||||
are applicable to SSH, SFTP and SCP. All parameters are optional
|
||||
and MUST NOT overwrite configured defaults. Individual parameters
|
||||
are separated by a comma (",").
|
||||
|
||||
fingerprint
|
||||
|
||||
The fingerprint parameter contains the fingerprint of the host key
|
||||
for the host specified in the URL. The fingerprint is encoded as
|
||||
in [3]. This parameter MUST NOT overwrite a key that is already
|
||||
configured for the host. They fingerprint MAY be used to validate
|
||||
the authenticity of the host key if the URL was obtained from an
|
||||
authenticated source with its integrity protected. If this
|
||||
parameter is not included then the validity of the host key is
|
||||
validated using another method. See Security Considerations section
|
||||
for additional considerations. There MUST be only one fingerprint
|
||||
parameter for a given URL.
|
||||
|
||||
cipher
|
||||
|
||||
The cipher parameter indicates an acceptable encryption mechanism to
|
||||
use in making the connection. The value is the string specifying the
|
||||
SSH cipher type. This parameter MUST NOT add a mechanism to a
|
||||
configured list of default configured acceptable encryption types.
|
||||
If this parameter is not specified then the default configured cipher
|
||||
list is used. There may be more than one cipher parameter.
|
||||
|
||||
integrity
|
||||
|
||||
The integrity parameter indicates an acceptable data integrity
|
||||
mechanism to use in making the connection. The value is the string
|
||||
specifying the SSH data integrity type. This parameter MUST NOT add
|
||||
a mechanism to a configured list of default configured acceptable
|
||||
data integrity types. If this parameter is not specified then the
|
||||
default configured data integrity list is used. There may be more
|
||||
than one integrity parameter.
|
||||
|
||||
key-xchg
|
||||
|
||||
The key-xchg parameter indicates an acceptable key exchange mechanism
|
||||
to use when making the connection. The value is the string
|
||||
specifying the SSH key exchange type. This parameter MUST NOT add a
|
||||
mechanism to a configured list of default configured acceptable key
|
||||
exchange types. If this parameter is not specified then the default
|
||||
configured key exchange list is used. There may be more than one
|
||||
key-xchg parameter.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 3]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
host-key-alg
|
||||
|
||||
The host-key-alg parameter indicates an host key to use when making
|
||||
the connection. The value is the string specifying the SSH host key
|
||||
type. This parameter MUST NOT add a mechanism to a configured list
|
||||
of default configured acceptable host key types. If this parameter
|
||||
is not specified then the default configured host key type list is
|
||||
used. There may be more than one host-key-alg parameter.
|
||||
|
||||
user-auth
|
||||
|
||||
The user-auth parameter indicates a user authentication mechanism to
|
||||
use when making the connection. The value is the string specifying
|
||||
the SSH user authentication mechanism type. This parameter MUST NOT
|
||||
add a mechanism to a configured list of default configured
|
||||
acceptable user authentication mechanism types. If this parameter
|
||||
is not specified then the default configured user authentication
|
||||
mechanism type list is used. There may be more than one user-auth
|
||||
parameter.
|
||||
|
||||
SFTP Parameters
|
||||
|
||||
The SFTP parameters determine how to handle the file transfer
|
||||
character translation.
|
||||
|
||||
newline
|
||||
|
||||
The newline parameter determines how the server translates new line
|
||||
indicators. The possible choices are usually "\r" or "\n" or "\r\n".
|
||||
The default is "\r\n".
|
||||
|
||||
typecode
|
||||
|
||||
The typecode identifies the type of file which determines how it
|
||||
will be treated. Possible values are "i" for binary files, "a" for
|
||||
text files, and "d" for directory listings.
|
||||
|
||||
|
||||
Examples
|
||||
|
||||
The following section shows basic examples of URLs for each
|
||||
protocol. This section should not be considered to include all
|
||||
possible combinations of URLs for each protocol.
|
||||
|
||||
ssh://user@host
|
||||
|
||||
ssh://user@host:2222
|
||||
|
||||
ssh://joeuser@example.com;fingerprint=c1:b1:30:29:d7:b8:de:6c
|
||||
:97:77:10:d7:46:41:63:87,cipher=aes-cbc
|
||||
|
||||
scp://user:password@host/file.txt
|
||||
|
||||
sftp://user@host/dir/path/file.txt
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 4]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
sftp://joeuser@example.com:2222;fingerprint=c1:b1:30:29:d7:b8
|
||||
:de:6c:97:77:10:d7:46:41:63:87,cipher=
|
||||
aes-cbc/pub/docs/test.txt;typecode=a
|
||||
|
||||
|
||||
Security Considerations
|
||||
|
||||
In general, URIs themselves have no security considerations.
|
||||
However, since the password for each scheme can optionally be
|
||||
included within the URL it should be noted that doing so poses a
|
||||
security risk. Since URLs are usually sent in the clear with no
|
||||
encryption or other security, any password or other credentials
|
||||
(userinfo) included could be seen by a potential attacker.
|
||||
|
||||
The fingerprint should only be used to validate the host key only if
|
||||
the URL can be determined to be authentic from a trusted entity.
|
||||
For example, the URL may be received through secure email or HTTPS
|
||||
from a trusted and verifiable source. It is possible that the SSH
|
||||
implementation may not be able to determine if the URL is authentic
|
||||
in which case it SHOULD prompt the user to either allow or disallow
|
||||
the connection based on the information provided. The SSH
|
||||
implementation MUST NOT overwrite a currently configured public key
|
||||
based on the URL alone.
|
||||
|
||||
The other connection parameters MUST NOT add any mechanism to the
|
||||
list of configured acceptable mechanisms defined in the SSH client.
|
||||
|
||||
Normative References
|
||||
|
||||
[1] Berners-Lee, T., Fielding, R., Masinter, L., "Uniform Resource
|
||||
Identifiers (URI): Generic Syntax", RFC 2396, August 1998.
|
||||
|
||||
[2] Masinter, L., et. al., "Guidelines for new URL Schemes", RFC
|
||||
2718, November 1999.
|
||||
|
||||
[3] Markus Friedl, "SSH Fingerprint Format",
|
||||
http://www.ietf.org/internet-drafts/
|
||||
draft-ietf-secsh-fingerprint-01.txt,
|
||||
work in progress
|
||||
|
||||
Non-Normative References
|
||||
|
||||
Mealling, M., Denenberg, R., "Report from the Joint W3C/IETF URI
|
||||
Planning Interest Group: Uniform Resource Identifiers (URIs), URLs,
|
||||
and Uniform Resource Names (URNs): Clarifications and
|
||||
Recommendations", RFC 3305, August 2002.
|
||||
|
||||
|
||||
Author Information
|
||||
|
||||
Steve Suehring
|
||||
Sentry Insurance
|
||||
1800 North Point Dr, G2/61-17
|
||||
Stevens Point, WI 54481
|
||||
suehring@braingia.com
|
||||
|
||||
Joseph Salowey
|
||||
Cisco Systems
|
||||
2901 Third Avenue
|
||||
Seattle, WA 98121
|
||||
E-mail: jsalowey@cisco.com
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 5]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
Intellectual Property Statement
|
||||
|
||||
The IETF takes no position regarding the validity or scope of any
|
||||
intellectual property or other rights that might be claimed to
|
||||
pertain to the implementation or use of the technology described in
|
||||
this document or the extent to which any license under such rights
|
||||
might or might not be available; neither does it represent that it
|
||||
has made any effort to identify any such rights. Information on the
|
||||
IETF's procedures with respect to rights in standards-track and
|
||||
standards-related documentation can be found in BCP-11. Copies of
|
||||
claims of rights made available for publication and any assurances of
|
||||
licenses to be made available, or the result of an attempt made to
|
||||
obtain a general license or permission for the use of such
|
||||
proprietary rights by implementors or users of this specification can
|
||||
be obtained from the IETF Secretariat.
|
||||
|
||||
The IETF invites any interested party to bring to its attention any
|
||||
copyrights, patents or patent applications, or other proprietary
|
||||
rights which may cover technology that may be required to practice
|
||||
this standard. Please address the information to the IETF Executive
|
||||
Director.
|
||||
|
||||
|
||||
Full Copyright Statement
|
||||
|
||||
Copyright (C) The Internet Society (2003). All Rights Reserved.
|
||||
|
||||
This document and translations of it may be copied and furnished to
|
||||
others, and derivative works that comment on or otherwise explain it
|
||||
or assist in its implementation may be prepared, copied, published
|
||||
and distributed, in whole or in part, without restriction of any
|
||||
kind, provided that the above copyright notice and this paragraph are
|
||||
included on all such copies and derivative works. However, this
|
||||
document itself may not be modified in any way, such as by removing
|
||||
the copyright notice or references to the Internet Society or other
|
||||
Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for
|
||||
copyrights defined in the Internet Standards process must be
|
||||
followed, or as required to translate it into languages other than
|
||||
English.
|
||||
|
||||
The limited permissions granted above are perpetual and will not be
|
||||
revoked by the Internet Society or its successors or assignees.
|
||||
|
||||
This document and the information contained herein is provided on an
|
||||
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
|
||||
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
|
||||
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
|
||||
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 6]
|
||||
|
||||
Internet Draft SCP/SFTP/SSH URI Format August 8, 2003
|
||||
|
||||
Acknowledgement
|
||||
|
||||
Funding for the RFC Editor function is currently provided by the
|
||||
Internet Society.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Suehring & Salowey Expires February 8, 2004 [Page 7]
|
||||
Reference in New Issue
Block a user