Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The "Getting Started" section in the kubernetes example appears to be incorrect #62

Open
monitz87 opened this issue Mar 4, 2023 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@monitz87
Copy link

monitz87 commented Mar 4, 2023

This might be because my use case is weird, but still.

I'm using Kustomize with the helmCharts option to inflate the 1password connect charts, but I'm deploying the secret that contains 1password-credentials.json using the command in the kubernetes example.

This is the command I'm referring to

kubectl create secret generic op-credentials --from-file=1password-credentials.json=./1password-credentials.json

That produces the following secret:

apiVersion: v1
data:
  1password-credentials.json:  <base64_encoded_file_contents>
kind: Secret
metadata:
  creationTimestamp: "2023-03-04T05:14:48Z"
  name: op-credentials
  namespace: default
  resourceVersion: "9983"
  uid: 4454843d-8d82-4a87-8f7a-366eaf34e753
type: Opaque

The problem is that what gets assigned to the OP_SESSION env variable in the connect-api container is already decoded, so it's the plain JSON contents of the file (I quadruple checked by opening an ssh tunnel into the container), but apparently the container expects the value to still be base64 encoded, and tries to decode it again.

This causes 500 errors when making requests to the API, which look like this in the service logs:

Server: (unable to get credentials and initialize API, retrying in 30s), Wrapped: (failed to FindCredentialsUniqueKey), Wrapped: (failed to loadCredentialsFile), Wrapped: (LoadLocalAuthV2 failed to credentialsDataFromBase64), illegal base64 data at input byte 0"

I managed to make things work by encoding the JSON to base64, encoding that base64 value to base64 AGAIN, and then manually creating the secret manifest file and assigning that doubly-encoded value to the data.1password-credentials.json key.

There's a chance that this is caused by a combination of the kubernetes (v1.25.4) and chart (non-specified, so I assume latest) versions I'm using. The images for both connect-api and connect-sync are at version 1.5.7.

It feels more like either a bug in the container or an error in the example docs, although my money is on the bug, I see no sensible reason why the file should be encoded/decoded twice.

I'm equal parts frustrated and proud for having finally figured this out.

Cheers

@pjmagee
Copy link

pjmagee commented Mar 18, 2023

I just had this problem today following the docs

@monitz87
Copy link
Author

monitz87 commented Mar 24, 2023

I'm going to shamelessly bump this.

I know fixing the bug is not trivial (lots of moving parts, updating the image, helm chart, tests, making sure everything works, etc etc).

On the other hand, adding a simple note in the docs explaining the bug and how to work around it should take less than 5 minutes, and it would save countless hours of dev time for users.

I'll happily submit a PR for the docs, but I'm not sure if you'd rather present it as a bug or intended behavior.

@damoun
Copy link

damoun commented Apr 3, 2023

I've got the same issue and so I also had to double encode 1password-credentals.json.

cat 1password-credentials.json|base64| tr -d \\n|base64

@monitz87
Copy link
Author

monitz87 commented Apr 4, 2023

If anyone from the team can tell me whether they want to present this in the docs as intended behavior or a bug with its corresponding workaround, I will gladly submit a PR that addresses the issue.

@ag-adampike ag-adampike self-assigned this Apr 4, 2023
@ag-adampike ag-adampike added the documentation Improvements or additions to documentation label Apr 4, 2023
@heliochronix
Copy link

heliochronix commented Jul 3, 2023

I too have ran into this issue when attempting to create a sealed secret for the credentials. It's a bit confusing how to go about this with the double encoding. Should I create the secret with --from-literal=1password-credentials.json=<base64 encoded 1password-credentials.json>?

@dannysauer
Copy link

@heliochronix , I assume you've just given up by now... But for future seekers of information: The key I finally stumbled across after way too long is to remove the line wraps base64 adds by default. If your chart is deployed to the namespace onepassword-whatever, which would be weird, and you're using the other helm chart defaults:

mv 1password-credentials.json 1password-credentials.json.pre-encode
base64 -w 0 < 1password-credentials.json.pre-encode > 1password-credentials.json
kubectl --namespace onepassword-whatever create secret generic op-credentials --from-file 1password-credentials.json

Another option for that middle step is cat 1password-credentials.json.pre-encode | base64 | tr -d \\n > 1password-credentials.json, though there are probably lots of other options too.

Either way, when you use the base64 CLI, you need to stop it from inserting newlines every 80 chars, because the second encode includes those newlines and results in a broken file. It shouldn't break, since most base64 decode implementations ignore newlines. I'd argue that's a bug. But this whole behavior is a little sketchy to begin with, so what's one more quirk? :D

@pabloaugusto
Copy link

Same issue here deploying 1password-connect do kubernetes managed by flux OS.
After 2 days trying make a deploy works. Finally done just encoding 1password-credentials.json to base64 after store it as a secret on ks8.

Please, update documentation or fix the bug!

@bmonty
Copy link

bmonty commented Aug 17, 2024

I'm in the process of setting up a new cluster managed by Flux. I ran into this issue attempting to install the op-credentials secret. I'm using SOPS to store the credentials encrypted in my git repo, and the substituteFrom feature of Kustomization to create the secrets for the 1Password connect operator. I had to double base64 encode the 1password-credential.json file and single base64 encode the token to get everything to work.

@smauermann
Copy link

I am now running into this as well. I am trying to make this work with the kustomize secretGenerator function and reading from files that I gitignore – I don't want to check in secrets. Now it took me a while figure out that I must base64 encode the connect credentials and not use the plain json to create the secret. Still I cannot make this work. Any pointers?

@smauermann
Copy link

I am now running into this as well. I am trying to make this work with the kustomize secretGenerator function and reading from files that I gitignore – I don't want to check in secrets. Now it took me a while figure out that I must base64 encode the connect credentials and not use the plain json to create the secret. Still I cannot make this work. Any pointers?

I think I know what happens, the kustomize secretGenerator is adding a newline to the provided values. I guess that behavior cannot be modified. How are people deploying this via ArgoCD without exposing secrets?

@upMKuhn
Copy link

upMKuhn commented Nov 7, 2024

@smauermann For me the issue occurred due to base64 introducing line breaks. Base64 -w 0 worked for me when encoding the file.

@krumware
Copy link

krumware commented Nov 9, 2024

I stumbled on this while creating a helper/wrapper chart.

In case this helps anyone else, in order to pass the unencoded json contents of the credential file via helm values, I needed to double encode like this.

apiVersion: v1
kind: Secret
metadata:
  name: op-credentials
  namespace: fleet-local
type: Opaque
data: 
  1password-credentials.json: |-
    {{ .Values.opcredentialjson | b64enc | b64enc }}

My portion of my values file then looks like this for that variable:

opconnecttoken: >-
  ey...
opcredentialjson: >-
  {"version":"2"...single-line...}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests