Skip to content

Commit 969daa7

Browse files
committed
renamed all NodeId to EndpointId
1 parent 7167829 commit 969daa7

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ or use ephemeral keys
124124

125125
```
126126

127-
Display its Node ID and share it to allow connection
127+
Display its Endpoint ID and share it to allow connection
128128

129129
![Starting server/Installing as service](/media/t-rec_server_service.gif)
130130
<br>
@@ -134,14 +134,14 @@ Display its Node ID and share it to allow connection
134134
// note: works only with persistent keys
135135
> iroh-ssh info
136136

137-
Your iroh-ssh nodeid: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
137+
Your iroh-ssh endpoint id: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
138138
iroh-ssh version 0.2.7
139139
https://github.com/rustonbsd/iroh-ssh
140140

141-
Your server iroh-ssh nodeid:
141+
Your server iroh-ssh endpoint id:
142142
iroh-ssh my-user@38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
143143

144-
Your service iroh-ssh nodeid:
144+
Your service iroh-ssh endpoint id:
145145
iroh-ssh my-user@4fjeeiui4jdm96005255c3begj389xk3aeaeef6cfebd88344aa8c85e1dbfc1ad
146146
```
147147

@@ -181,7 +181,7 @@ Display its Node ID and share it to allow connection
181181
## Commands
182182

183183
```bash
184-
# Get your Node ID and info
184+
# Get your Endpoint ID and info
185185
> iroh-ssh info
186186

187187
# Server modes
@@ -194,13 +194,13 @@ Display its Node ID and share it to allow connection
194194
> iroh-ssh service uninstall # Uninstall service
195195

196196
# Client connection
197-
> iroh-ssh user@<NODE_ID> # Connect to remote server
198-
> iroh-ssh connect user@<NODE_ID> # Explicit connect command, works with all standard ssh params and flags
197+
> iroh-ssh user@<ENDPOINT_ID> # Connect to remote server
198+
> iroh-ssh connect user@<ENDPOINT_ID> # Explicit connect command, works with all standard ssh params and flags
199199
```
200200

201201
## Security Model
202202

203-
- **Node ID access**: Anyone with the Node ID can reach your SSH port
203+
- **Endpoint ID access**: Anyone with the Endpoint ID can reach your SSH port
204204
- **SSH authentication**: SSH key file, certificate and password auth are supported
205205
- **Persistent keys**: Uses dedicated `.ssh/iroh_ssh_ed25519` keypair
206206
- **QUIC encryption**: Transport layer encryption between endpoints

README_es.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ Mostrar su ID de nodo y compártalo para permitir la conexión
134134
// nota: funciona solo con llaves persistentes
135135
> iroh-ssh info
136136

137-
Your iroh-ssh nodeid: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
137+
Your iroh-ssh endpoint id: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
138138
iroh-ssh version 0.2.7
139139
https://github.com/rustonbsd/iroh-ssh
140140

141-
Your server iroh-ssh nodeid:
141+
Your server iroh-ssh endpoint id:
142142
iroh-ssh my-user@38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
143143

144-
Your service iroh-ssh nodeid:
144+
Your service iroh-ssh endpoint id:
145145
iroh-ssh my-user@4fjeeiui4jdm96005255c3begj389xk3aeaeef6cfebd88344aa8c85e1dbfc1ad
146146
```
147147

@@ -194,8 +194,8 @@ Mostrar su ID de nodo y compártalo para permitir la conexión
194194
> iroh-ssh service uninstall # Desinstalar servicio
195195

196196
# Conexión de cliente
197-
> iroh-ssh user@<NODE_ID> # Conectarse a un servidor remoto
198-
> iroh-ssh connect user@<NODE_ID> # Comando de conexión explicito, funciona con todos los parametros y opciones ssh estándar
197+
> iroh-ssh user@<ENDPOINT_ID> # Conectarse a un servidor remoto
198+
> iroh-ssh connect user@<ENDPOINT_ID> # Comando de conexión explicito, funciona con todos los parametros y opciones ssh estándar
199199
```
200200

201201
## Modelo de seguridad

README_pt.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ Exiba seu ID de nó e compartilhe-o para permitir a conexão
134134
// nota: funciona apenas com chaves persistentes
135135
> iroh-ssh info
136136

137-
Your iroh-ssh nodeid: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
137+
Your iroh-ssh endpoint id: 38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
138138
iroh-ssh version 0.2.7
139139
https://github.com/rustonbsd/iroh-ssh
140140

141-
Your server iroh-ssh nodeid:
141+
Your server iroh-ssh endpoint id:
142142
iroh-ssh my-user@38b7dc10df96005255c3beaeaeef6cfebd88344aa8c85e1dbfc1ad5e50f372ac
143143

144-
Your service iroh-ssh nodeid:
144+
Your service iroh-ssh endpoint id:
145145
iroh-ssh my-user@4fjeeiui4jdm96005255c3begj389xk3aeaeef6cfebd88344aa8c85e1dbfc1ad
146146
```
147147

@@ -194,8 +194,8 @@ Exiba seu ID de nó e compartilhe-o para permitir a conexão
194194
> iroh-ssh service uninstall # Desinstalar serviço
195195

196196
# Conexão do cliente
197-
> iroh-ssh user@<NODE_ID> # Conectar-se a um servidor remoto
198-
> iroh-ssh connect user@<NODE_ID> # Comando de conexão explícito, funciona com todos os parâmetros e flags ssh padrão
197+
> iroh-ssh user@<ENDPOINT_ID> # Conectar-se a um servidor remoto
198+
> iroh-ssh connect user@<ENDPOINT_ID> # Comando de conexão explícito, funciona com todos os parâmetros e flags ssh padrão
199199
```
200200

201201
## Modelo de segurança

src/api.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ pub async fn info_mode() -> anyhow::Result<()> {
3737

3838
if let Some(key) = server_key {
3939
println!();
40-
println!("Your server iroh-ssh nodeid:");
40+
println!("Your server iroh-ssh endpoint id:");
4141
println!(" iroh-ssh {}@{}", whoami::username(), key.clone().public());
4242
println!();
4343
}
4444

4545
if let Some(key) = service_key {
4646
println!();
47-
println!("Your service iroh-ssh nodeid:");
47+
println!("Your service iroh-ssh endpoint id:");
4848
println!(" iroh-ssh {}@{}", whoami::username(), key.clone().public());
4949
println!();
5050
}
@@ -84,7 +84,7 @@ pub async fn server_mode(server_args: ServerArgs, service: bool) -> anyhow::Resu
8484
println!(
8585
"\n iroh-ssh {}@{}\n",
8686
whoami::username(),
87-
iroh_ssh.node_id()
87+
iroh_ssh.endpoint_id()
8888
);
8989
if server_args.persist {
9090
let distro_home = my_home()?.ok_or_else(|| anyhow::anyhow!("home directory not found"))?;
@@ -109,12 +109,12 @@ pub async fn server_mode(server_args: ServerArgs, service: bool) -> anyhow::Resu
109109

110110
pub async fn proxy_mode(proxy_args: ProxyArgs) -> anyhow::Result<()> {
111111
let iroh_ssh = IrohSsh::builder().accept_incoming(false).build().await?;
112-
let endpoint_id = EndpointId::from_str(if proxy_args.node_id.len() == 64 {
113-
&proxy_args.node_id
114-
} else if proxy_args.node_id.len() > 64 {
115-
&proxy_args.node_id[proxy_args.node_id.len() - 64..]
112+
let endpoint_id = EndpointId::from_str(if proxy_args.endpoint_id.len() == 64 {
113+
&proxy_args.endpoint_id
114+
} else if proxy_args.endpoint_id.len() > 64 {
115+
&proxy_args.endpoint_id[proxy_args.endpoint_id.len() - 64..]
116116
} else {
117-
return Err(anyhow::anyhow!("invalid node id length"));
117+
return Err(anyhow::anyhow!("invalid endpoint id length"));
118118
})?;
119119
iroh_ssh.connect(endpoint_id).await
120120
}

src/cli.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use std::{ffi::OsString, path::PathBuf};
22

33
use clap::{ArgAction, Args, Parser, Subcommand, command};
44

5-
const TARGET_HELP: &str = "Target in the form user@NODE_ID";
5+
const TARGET_HELP: &str = "Target in the form user@ENDPOINT_ID";
66

77
#[derive(Parser, Debug)]
88
#[command(name = "iroh-ssh", about = "ssh without ip")]
@@ -39,8 +39,8 @@ pub enum Cmd {
3939

4040
#[derive(Args, Clone, Debug)]
4141
pub struct ProxyArgs {
42-
#[arg(help = "Proxy node ID")]
43-
pub node_id: String,
42+
#[arg(help = "Proxy Endpoint ID")]
43+
pub endpoint_id: String,
4444
}
4545

4646
#[derive(Args, Clone, Debug)]
@@ -78,11 +78,11 @@ pub struct SshOpts {
7878
pub identity_file: Option<PathBuf>,
7979

8080
#[arg(short = 'L', value_name = "LPORT:HOST:RPORT",
81-
help = "Local forward [bind_addr:]lport:host:rport (host can't be node_id yet)", action = ArgAction::Append)]
81+
help = "Local forward [bind_addr:]lport:host:rport (host can't be endpoint_id yet)", action = ArgAction::Append)]
8282
pub local_forward: Vec<String>,
8383

8484
#[arg(short = 'R', value_name = "RPORT:HOST:LPORT",
85-
help = "Remote forward [bind_addr:]rport:host:lport (host can't be node_id yet)", action = ArgAction::Append)]
85+
help = "Remote forward [bind_addr:]rport:host:lport (host can't be endpoint_id yet)", action = ArgAction::Append)]
8686
pub remote_forward: Vec<String>,
8787

8888
#[arg(

src/ssh.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ impl IrohSsh {
198198
Ok(())
199199
}
200200

201-
pub fn node_id(&self) -> EndpointId {
201+
pub fn endpoint_id(&self) -> EndpointId {
202202
self.inner
203203
.as_ref()
204204
.expect("inner not set")

0 commit comments

Comments
 (0)