package commands import ( "context" "errors" "fmt" "io" "strings" "time" cmds "github.com/ipfs/go-ipfs/commands" core "github.com/ipfs/go-ipfs/core" e "github.com/ipfs/go-ipfs/core/commands/e" keystore "github.com/ipfs/go-ipfs/keystore" path "gx/ipfs/Qme34dT9spiPgunbueNtziRX4SvfLHDFZQvmTBVK8p4qNT/go-path" "gx/ipfs/QmdE4gMduCKCGAcczM2F5ioYDfdeKuPix138wrES1YSr7f/go-ipfs-cmdkit" peer "gx/ipfs/QmdVrMn1LhB4ybb8hMVaMLXnA8XRSewMnK6YqXKXoTcRvN/go-libp2p-peer" crypto "gx/ipfs/Qme1knMqwt1hKZbc1BmQFmnm9f36nyQGwXxPGVpVJ9rMK5/go-libp2p-crypto" ) var errNotOnline = errors.New("this command must be run in online mode. Try running 'ipfs daemon' first") var PublishCmd = &cmds.Command{ Helptext: cmdkit.HelpText{ Tagline: "Publish IPNS names.", ShortDescription: ` IPNS is a PKI namespace, where names are the hashes of public keys, and the private key enables publishing new (signed) values. In both publish and resolve, the default name used is the node's own PeerID, which is the hash of its public key. `, LongDescription: ` IPNS is a PKI namespace, where names are the hashes of public keys, and the private key enables publishing new (signed) values. In both publish and resolve, the default name used is the node's own PeerID, which is the hash of its public key. You can use the 'ipfs key' commands to list and generate more names and their respective keys. Examples: Publish an with your default name: > ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Publish an with another name, added by an 'ipfs key' command: > ipfs key gen --type=rsa --size=2048 mykey > ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Published to QmSrPmbaUKA3ZodhzPWZnpFgcPMFWF4QsxXbkWfEptTBJd: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Alternatively, publish an using a valid PeerID (as listed by 'ipfs key list -l'): > ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy `, }, Arguments: []cmdkit.Argument{ cmdkit.StringArg("ipfs-path", true, false, "ipfs path of the object to be published.").EnableStdin(), }, Options: []cmdkit.Option{ cmdkit.BoolOption("resolve", "Resolve given path before publishing.").WithDefault(true), cmdkit.StringOption("lifetime", "t", `Time duration that the record will be valid for. <> This accepts durations such as "300s", "1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".`).WithDefault("24h"), cmdkit.StringOption("ttl", "Time duration this record should be cached for (caution: experimental)."), cmdkit.StringOption("key", "k", "Name of the key to be used or a valid PeerID, as listed by 'ipfs key list -l'. Default: <>.").WithDefault("self"), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() if err != nil { res.SetError(err, cmdkit.ErrNormal) return } if !n.OnlineMode() { err := n.SetupOfflineRouting() if err != nil { res.SetError(err, cmdkit.ErrNormal) return } } if n.Mounts.Ipns != nil && n.Mounts.Ipns.IsActive() { res.SetError(errors.New("cannot manually publish while IPNS is mounted"), cmdkit.ErrNormal) return } pstr := req.Arguments()[0] if n.Identity == "" { res.SetError(errors.New("identity not loaded"), cmdkit.ErrNormal) return } popts := new(publishOpts) popts.verifyExists, _, _ = req.Option("resolve").Bool() validtime, _, _ := req.Option("lifetime").String() d, err := time.ParseDuration(validtime) if err != nil { res.SetError(fmt.Errorf("error parsing lifetime option: %s", err), cmdkit.ErrNormal) return } popts.pubValidTime = d ctx := req.Context() if ttl, found, _ := req.Option("ttl").String(); found { d, err := time.ParseDuration(ttl) if err != nil { res.SetError(err, cmdkit.ErrNormal) return } ctx = context.WithValue(ctx, "ipns-publish-ttl", d) } kname, _, _ := req.Option("key").String() k, err := keylookup(n, kname) if err != nil { res.SetError(err, cmdkit.ErrNormal) return } pth, err := path.ParsePath(pstr) if err != nil { res.SetError(err, cmdkit.ErrNormal) return } output, err := publish(ctx, n, k, pth, popts) if err != nil { res.SetError(err, cmdkit.ErrNormal) return } res.SetOutput(output) }, Marshalers: cmds.MarshalerMap{ cmds.Text: func(res cmds.Response) (io.Reader, error) { v, err := unwrapOutput(res.Output()) if err != nil { return nil, err } entry, ok := v.(*IpnsEntry) if !ok { return nil, e.TypeErr(entry, v) } s := fmt.Sprintf("Published to %s: %s\n", entry.Name, entry.Value) return strings.NewReader(s), nil }, }, Type: IpnsEntry{}, } type publishOpts struct { verifyExists bool pubValidTime time.Duration } func publish(ctx context.Context, n *core.IpfsNode, k crypto.PrivKey, ref path.Path, opts *publishOpts) (*IpnsEntry, error) { if opts.verifyExists { // verify the path exists _, err := core.Resolve(ctx, n.Namesys, n.Resolver, ref) if err != nil { return nil, err } } eol := time.Now().Add(opts.pubValidTime) err := n.Namesys.PublishWithEOL(ctx, k, ref, eol) if err != nil { return nil, err } pid, err := peer.IDFromPrivateKey(k) if err != nil { return nil, err } return &IpnsEntry{ Name: pid.Pretty(), Value: ref.String(), }, nil } func keylookup(n *core.IpfsNode, k string) (crypto.PrivKey, error) { res, err := n.GetKey(k) if res != nil { return res, nil } if err != nil && err != keystore.ErrNoSuchKey { return nil, err } keys, err := n.Repo.Keystore().List() if err != nil { return nil, err } for _, key := range keys { privKey, err := n.Repo.Keystore().Get(key) if err != nil { return nil, err } pubKey := privKey.GetPublic() pid, err := peer.IDFromPublicKey(pubKey) if err != nil { return nil, err } if pid.Pretty() == k { return privKey, nil } } return nil, fmt.Errorf("no key by the given name or PeerID was found") }