Prova Keybase do Discourse

Ok, so I should just redirect back to the new_proof_url endpoint, fair enough :slight_smile:

yeah. redirecting is perfect. it doesn’t have to redirect to new it could also go to the user’s profile page or settings page or something like that as long as the flash notice tells the user something actionable. whatever makes the most sense. i’m not really sure. no opinions.

the logged-in user is the discourse user that is making the proof

absolutely. yes. it looked like here we’re only checking if it’s the correct user on create and i’d argue we should also do it on new. there’s no sense in trying to save a proof that we know will fail.

The code I pushed is not the latest. I rewrote the create method, removing the check for the username param as it should not be necessary anymore (as the proof_valid? check will fail).

The new method is just a placeholder for Discourse routing logic, it will never be called and it needs to allow non-logged-in requests to allow the user to log in if they logged off previously :slight_smile:

EDIT: this is the new code I just pushed (still not very polished, I pushed it just to let you see it).

2 curtidas

About setting up a test domain: it would be great :slight_smile:

3 curtidas

I am having issues updating the proof custom field. The first time I put a JSON object in it, it works, but any attempt to change the value of the custom field fails. This is the code:

    def create
      kb_username = params.fetch('kb_username')
      sig_hash = params.fetch('sig_hash')

      proof = Proof.new(current_user.username, kb_username, sig_hash)
      unless proof.valid?
        raise Discourse::InvalidParameters, I18n.t('keybase_proofs.invalid_proof')
      end

      proofs = current_user.custom_fields['keybase_proofs'] || {}
      # Override the signature because the old one might have been
      # revoked and not yet updated on our side.
      proofs[kb_username] = proof.signature

      current_user.custom_fields['keybase_proofs'] = proofs
      current_user.save
      
      render json: success_json
    end

the first time this code is called, it adds the proofs to the custom field named "keybase_proofs". If I call it again, it doesn’t update the custom field.

Some more information: if I change the type of the custom field to a string, it works correctly.

1 curtida

Is that code up to date in GitHub?

I assume that

Is not returning a hash, so on the first time it works because you coalesce it to an empty Hash. But it fails on subsequent tries because it’s returning something else.

Adding a debugging break point there may help.

2 curtidas

Unfortunately not. Since I am learning how everything works together, my code is almost always in a very sad shape, not really worth pushing. But the code that is in GitHub shows exactly the same issue (but I didn’t push the tests).

In the latest version of the code, which I have locally, I got rid of the JSON type and I am just using serialized JSON strings instead, and it is now working fine.

This is not the case. When I say that “it fails”, I mean “it fails to update” the field. So the first time the code runs, it saves the custom field correctly (I can also retrieve it, I use the data in the profile page and in the check proof endpoint). The second time I run the code (ie, if I add another Keybase identity to the same Discourse user), the custom field is not updated, it keeps only the first signature I added.

In case you’re curious and you want to debug the issue, I’ll create a branch with the original code and tests (that were failing) so you can investigate :slight_smile:

Unfortunately I don’t know how to do it for this codebase using VS Code :frowning: do you have any advice on an alternative editor? RubyMine?

Thanks!

You can add a byebug to any line in the controller, and when that line is hit the console where you started the webserver (the one you run bin/unicorn -x) will stop and allow you to inspect the variables.

9 curtidas

The debugger confirms what I saw with previous testing: the JSON is stored the first time, and any attempt to change it later gets silently ignored. Anyway, for now I have fixed it by manually parsing/encoding the JSON string in the custom field.

Hello everyone! In particular @sam and @kb_xgess.

The plugin is in good enough shape now to get reviewed: GitHub - etamponi/discourse-keybase-proofs-plugin: Discourse Plugin for Keybase Proofs.

It should mostly work. There are a few things to fix before it is “shippable”:

  • The “new proof” UI needs some CSS love. It should also show an error if the logged in user is not the one for which the proof is requested.
  • The config endpoint /keybase-proofs/config needs a couple of SVG logos, but I don’t know where to get them from. Ideas? @kb_xgess, do they need to be SVG? Do you need both the black&white and the colored one?
  • redirect-after-login doesn’t work currently. @techAPJ is investigating, might be a bug in Discourse core or (more likely?) a bug somewhere in the plugin.

Some notes on code quality:

  • I didn’t write frontend tests. I think I’ve got the gist of how to write tests for components, but I didn’t want to spend more time figuring out how to mock requests and so on.
  • proof_controller.rb has a very ugly pic_url method, needed because I couldn’t make the call to the keybase API from the client because of CORS. I guess it can be moved to somewhere else or someone can figure out how to fetch the information from the client side.
  • I didn’t run any linter/formatter on the code. Should I?
  • The README might need some love :slight_smile:
7 curtidas

Adoraria testá-lo. Existe uma instância de teste disponível?

2 curtidas

Qual é a URL do endpoint? Talvez possa ser solicitada aos desenvolvedores?

Até onde sei, isso precisa ser permitido por instância pela equipe do Keybase.

@kb_xgess, você poderia adicionar o meta.discourse.org para nós?

2 curtidas

Estou dando uma olhada em parte do seu código agora. :slight_smile: ótimo progresso! Uma pergunta rápida sobre meta.discourse.org: ele está rodando uma base de código diferente? Podemos implantar seu código nele? Pergunto porque parte do protocolo de ida e volta envolve o Keybase acessar o Discourse para verificar a prova hospedada. Se não estiver lá, tudo vai falhar. Então, talvez seja mais fácil para você iterar em um servidor público que seja menos voltado para produção. Faz sentido? Talvez um ambiente de staging ou de desenvolvimento hospedado. Ou, se você tiver uma conta no ngrok, podemos criar uma URL estática que sempre faça proxy para o seu localhost, ativada apenas quando você quiser (totalmente do seu lado). Se você tiver a flexibilidade necessária no meta.discourse.org, posso ativá-la para esse site com as configurações do seu código e algumas outras configurações padrão.

Outra pergunta sobre os SVGs. Os SVGs são ideais porque, na verdade, precisamos de vários PNGs de tamanhos diferentes para o aplicativo móvel, o aplicativo desktop e o site, e provavelmente será mais fácil para todos se pudermos renderizá-los todos a partir das mesmas entradas iniciais.

5 curtidas

Isso é decepcionante. É necessariamente assim, @kb_xgess? Eu esperava que fosse possível, digamos, fornecer ao KeyBase um link para um perfil em qualquer servidor Discourse executando o plugin (ou em qualquer servidor Discourse, se for incorporado ao núcleo) e, assim, você poderia ter a prova em qualquer servidor Discourse.

Isso ficou muito claro na postagem de anúncio deles quando o serviço foi lançado.

Se você puder adicionar domínios facilmente, por favor, adicione um para keybase-test.demo.discourse.org, que estarei configurando em breve para nossos testes.

4 curtidas

Ah. Acho que não tenho acompanhado tão de perto quanto pensava. :crying_cat_face:

Espera. Isso não é o que entendo da mensagem original:

Ah, mas Keybase ♥'s Mastodon, and how to get your site on Keybase diz que eles não farão link para

Isso faz sentido, infelizmente. :wink:

6 curtidas

Sim, o plano é criar todas as ferramentas necessárias, e tenho certeza de que @kb_xgess as habilitará para comunidades onde fizer sentido. Isso não significa que toda cidade fantasma ou instância que exige login terá acesso a elas.

4 curtidas

Esse método antigo é suportado pelo plugin? Não estou claro sobre isso.

1 curtida

Não, o novo método é, mas isso requer aprovação na lista branca do Keybase.

É assim que você prova ao KeyBase que é dono de um site. Achei que um método semelhante pudesse funcionar. Eu estava errado.